https://github.com/kavyaballa1020/markdown-editor-react
A simple, powerful Markdown editor built with React. Features live preview, syntax highlighting, and responsive design. Perfect for documentation, blogging, and note-taking.
https://github.com/kavyaballa1020/markdown-editor-react
css html5 javascript reactjs
Last synced: 6 months ago
JSON representation
A simple, powerful Markdown editor built with React. Features live preview, syntax highlighting, and responsive design. Perfect for documentation, blogging, and note-taking.
- Host: GitHub
- URL: https://github.com/kavyaballa1020/markdown-editor-react
- Owner: kavyaballa1020
- License: mit
- Created: 2024-06-14T11:38:10.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-11T13:34:30.000Z (7 months ago)
- Last Synced: 2024-11-11T14:31:22.621Z (7 months ago)
- Topics: css, html5, javascript, reactjs
- Language: CSS
- Homepage: https://kav-markdown-editor.vercel.app/
- Size: 3.92 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown Editor
A simple and powerful Markdown editor built with React.
## Features
- **Live Preview:** See the rendered HTML as you type.
- **Syntax Highlighting:** Color-coded Markdown syntax for easier editing.
- **Responsive Design:** Works seamlessly on both desktop and mobile devices.
- **Customizable:** Easily modify and extend the functionality.
## Demo
Check out the live demo [here](#).
## Installation
To get started with the Markdown Editor, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/kavyaballa1020/Markdown-Editor-React.git
cd markdown-editor
```
2. **Install dependencies:**
```bash
npm install
```
3. **Start the development server:**
```bash
npm start
```
The application will be available at `http://localhost:3000`.
## Usage
Once the application is running, you can start typing your Markdown content on the left pane, and the live preview will be displayed on the right pane.
## Scripts
Here are some useful scripts you can run:
- `npm start`: Starts the development server.
- `npm run build`: Builds the application for production.
- `npm test`: Runs the test suite.
## Contributing
Contributions are welcome! If you have any suggestions or improvements, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Acknowledgements
- [React](https://reactjs.org/)
- [Marked](https://github.com/markedjs/marked)
- [PrismJS](https://prismjs.com/)
## Contact
If you have any questions or feedback, please reach out to me at [[email protected]].
---