Skip to content

Markdown editor built with React and the Mantine UI library. It allows users to easily write and preview Markdown text with a variety of styling options, including headings, bold and italic text, links, and images. The website is built using Create React App and is designed to be fast, responsive, and easy to use.

Notifications You must be signed in to change notification settings

codywall/minimalist-markdown-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Markdown editor built with React and the Mantine UI library. It allows users to easily write and preview Markdown text with a variety of styling options, including headings, bold and italic text, links, and images. The website is built using Create React App and is designed to be fast, responsive, and easy to use.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published