A simple and efficient React-based web application that allows users to write Markdown text and see the rendered HTML preview in real-time.
- Live Preview: See changes instantly as you type.
- GitHub Flavored Markdown: Supports standard GFM syntax including tables, task lists, and code blocks.
- Responsive Design: Works on desktop and mobile browsers.
- Syntax Highlighting: Built-in support for code snippets.
| Main Interface | Editor View & Rendered Output |
|---|---|
 |
 |
- Node.js (v14 or higher)
- npm or yarn
-
Clone the repository:
git clone https://github.com/aadhar41/react-markdown-previewer.git
-
Navigate to the project directory:
cd react-markdown-previewer -
Install dependencies:
npm install
-
Start the development server:
npm start
The application will be available at http://localhost:3000.
markdown-preview/
├── public/
│ └── screens/ # Application screenshots
├── src/
│ ├── components/ # React components
│ ├── App.js # Main application logic
│ └── index.js # Entry point
└── README.md
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Code of Conduct: Please read our Code of Conduct to understand the standards of behavior we expect in our community.
- Contributing: Check out the Contributing Guidelines for details on our code of conduct and the process for submitting pull requests.
- Security: Please refer to our Security Policy.
- Issue Templates: When opening an issue, please use the provided Bug Report or Feature Request templates.
Distributed under the MIT License. See LICENSE for more information.
- GitHub: @aadhar41
- LinkedIn: aadhar-gaur-php
Co-authored-by: Aadhar gaur aadhargaur41@users.noreply.github.com
- React Markdown for the core rendering logic.
- Built with ❤️ by Aadhar Gaur.