A Markdown preview application built using React.js and a markdown library. It allows users to write and preview markdown in real-time.
not live currently
List the key features of your Markdown preview application. For example:
- Real-time preview of markdown as you type
- Support for various markdown elements (headings, lists, bold, italic, etc.)
- Responsive design for different screen sizes
Provide instructions on how to install and set up the project locally. Include any dependencies that need to be installed and the steps to run the application. For example:
- Clone the repository:
git clone https://github.com/Hardik-Metaliya/Markdown-Editor-React-
- Navigate to the project directory:
cd Marddown-Editor-React-
- Install dependencies:
npm install
- Start the development server:
npm start
- Open your browser and visit
http://localhost:3000
to see the application.
Provide instructions on how to use your Markdown preview application. Explain any features or functionalities and give examples. For example:
-
Open the application in your browser.
-
Start typing markdown content in the input area.
-
The preview pane will update in real-time to show the rendered markdown.
-
Experiment with different markdown elements like headings, lists, links, and more.
Explain how others can contribute to your project. This could include guidelines for submitting bug reports, feature requests, or pull requests. For example:
Contributions are welcome! If you encounter any bugs or have suggestions for new features, please open an issue or submit a pull request. Make sure to follow the existing code style and write tests for any new functionality.
Specify the license under which you are releasing your project. For example, the MIT License:
This project is licensed under the MIT License - see the LICENSE file for details.