This project is a Markdown editor built with Next.js. It utilizes the following libraries:
- Next.js: The React Framework for Production.
- TypeScriptThis project built using TypeScript.
- react-icons: Include popular icons in your React projects easily.
- react-markdown: Render Markdown as React components.
- remark-gfm: GitHub Flavored Markdown (GFM) support for
remark
. - clsx: A tiny utility for constructing
className
strings conditionally. - tailwindcss: A utility-first CSS framework for rapid UI development.
- @tailwindcss/typography: A plugin that provides a set of prose classes you can use to style your content.
This project provides a simple and intuitive interface for editing Markdown with real-time preview. You can add various icons and use GitHub Flavored Markdown features seamlessly.
To get started with the project, follow these steps:
- Clone the repository:
git clone https://github.com/yourusername/your-repo-name.git
- Navigate to the project directory:
cd your-repo-name
- Install the dependencies:
npm install
- Run the development server:
npm run dev
If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.