Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 1.36 KB

File metadata and controls

60 lines (37 loc) · 1.36 KB

Markdown Editor

A simple and customizable markdown editor built with React and Mantine UI.

Features

  • Live preview of markdown content
  • Add markdown syntax with buttons or keyboard shortcuts
  • Customizable heading levels (H1 to H6)
  • Toggle between raw markdown and styled output
  • Zoom in and out to adjust font size
  • Undo functionality for inserting markdown tags

Installation

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

Start the development server:

npm start

Your Markdown Editor will be running at http://localhost:3000.

Usage

Type or paste your markdown content into the editor textarea. The editor provides a live preview of the formatted content as you type.

Use the toolbar buttons to quickly insert markdown syntax for bold, italic, links, images, and headings. You can also use keyboard shortcuts for the same.

Toggle between raw markdown and styled output using the 'Toggle Preview' button.

Adjust the font size using the 'Zoom In' and 'Zoom Out' buttons.

Undo the insertion of markdown tags using the Cmd/Ctrl+Z keyboard shortcut.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT