https://github.com/elinoza/markdown-editor

a markdown-editor with synchronized preview built with nextjs & typescript & tailwindCSS
https://github.com/elinoza/markdown-editor

markdown markdown-editor nextjs tailwindcss typescript

Last synced: 3 days ago
JSON representation

a markdown-editor with synchronized preview built with nextjs & typescript & tailwindCSS

• Host: GitHub
• URL: https://github.com/elinoza/markdown-editor
• Owner: elinoza
• Created: 2024-06-01T16:41:51.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-06-10T23:07:47.000Z (4 months ago)
• Last Synced: 2024-09-24T21:14:27.086Z (3 days ago)
• Topics: markdown, markdown-editor, nextjs, tailwindcss, typescript
• Language: TypeScript
• Homepage: https://markdown-editor-eta-one.vercel.app/
• Size: 151 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Markdown Editor

This project is a Markdown editor built with Next.js. It utilizes the following libraries:



## Libraries Used

- **Next.js**: The React Framework for Production.

- **TypeScript**This 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.

## Usage

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.

## Installation

To get started with the project, follow these steps:

1. Clone the repository:

    ```bash

    git clone https://github.com/yourusername/your-repo-name.git

    ```

2. Navigate to the project directory:

    ```bash

    cd your-repo-name

    ```

3. Install the dependencies:

    ```bash

    npm install

    ```

4. Run the development server:

    ```bash

    npm run dev

    ```

## Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.