This repository contains the code for a Markdown Previewer web application. The Markdown Previewer allows users to write and preview markdown syntax in real-time. It provides a convenient way to create formatted content, such as documentation, blog posts, and README files, using simple and intuitive markup.
The project is built using React and utilizes the marked library for rendering the markdown. It follows the specifications of the freeCodeCamp challenge: Build a Markdown Previewer.
- Real-time preview of markdown syntax
- Editable markdown input area
- Rendering of markdown into HTML
- Support for common markdown elements such as headings, lists, links, and more
To see the Markdown Previewer in action, visit the live demo.
- React: JavaScript library for building user interfaces
- marked: A markdown parser and compiler for JavaScript
- HTML: Markup language for structuring the web page
- CSS: Styling language for designing the user interface
To run the Markdown Previewer locally, follow these steps:
- Clone the repository:
git clone https://github.com/milliorn/markdown-previewer.git - Navigate to the project directory:
cd markdown-previewer - Install the dependencies:
npm install - Start the development server:
npm start - Open http://localhost:3000 in your browser to view the Markdown Previewer.
Contributions are welcome! If you have any suggestions, improvements, or bug fixes, please create an issue or submit a pull request.
The project is deployed using GitHub Pages. The live demo can be accessed at http://milliorn.github.io/markdown-previewer.
This project is licensed under the MIT License.
The Markdown Previewer project is part of the freeCodeCamp curriculum. Special thanks to freeCodeCamp for providing the project specifications and resources.