A beautiful and feature-rich Markdown editor built with Next.js, Tiptap, and shadcn/ui. This project provides a modern, responsive, and customizable editing experience with real-time Markdown preview and syntax highlighting.
- Rich text editing with Markdown support
- Real-time Markdown preview
- Syntax highlighting for code blocks
- Dark mode support
- Responsive design
- Customizable UI with shadcn/ui components
Before you begin, ensure you have met the following requirements:
- Node.js (v14 or later)
- npm (v6 or later)
To install the Markdown Editor, follow these steps:
-
Clone the repository:
git clone https://github.com/yourusername/markdown-editor.git -
Navigate to the project directory:
cd markdown-editor -
Install the dependencies:
npm install
To run the Markdown Editor locally, use the following command:
npm run dev
This will start the development server. Open http://localhost:3000 in your browser to view the application.
Contributions to the Markdown Editor are welcome! Here's how you can contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name. - Make your changes and commit them:
git commit -m 'Add some feature'. - Push to the branch:
git push origin feature/your-feature-name. - Submit a pull request.
Please make sure to update tests as appropriate and adhere to the existing coding style.
This project is licensed under the MIT License. See the LICENSE file for details.
If you have any questions or feedback, please open an issue on the GitHub repository.