Markdown Editor is a simple web application built using React. It allows users to write Markdown text and see the live preview of the rendered HTML output. This project is beginner-friendly and serves as a great introduction to React, Markdown parsing, and context management.
- Write Markdown text in the Raw Input Area.
- See the live preview of the rendered HTML output in the Markdown Sanitized Output section.
- Convert Markdown text to HTML with the click of a button.
- Responsive design for use on desktop and mobile devices.
-
Clone the repository:
git clone https://github.com/XYM-2001/markdown-editor.git
-
Navigate to the project directory:
cd markdown-editor -
Install dependencies:
npm install
-
Start the development server:
npm start
- Open the application in your web browser (http://localhost:3000 by default). Enter Markdown text in the Raw Input Area. Click the "Convert to HTML" button to see the live preview of the rendered HTML output in the Markdown Sanitized Output section. Edit the Markdown text or click the button again to update the HTML output. Technologies Used React JavaScript HTML CSS Remarkable (Markdown parsing library) Contributing Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
License This project is licensed under the MIT License.
Acknowledgements Special thanks to the developers of React and Remarkable for their amazing tools. Inspiration for this project came from the need for a simple Markdown editor for personal use.