https://github.com/mehradevesh2022/markdown-creater
Create and manage Markdown notes effortlessly with Markdown Writer, a React-based Markdown editor. Edit, preview, and organize your content seamlessly.
https://github.com/mehradevesh2022/markdown-creater
browser-api markdown-editor markdown-viewer mini-project open-source react-editor react-markdown react-mde react-showdown reactjs resume-project showdown-js text-editor
Last synced: about 2 months ago
JSON representation
Create and manage Markdown notes effortlessly with Markdown Writer, a React-based Markdown editor. Edit, preview, and organize your content seamlessly.
- Host: GitHub
- URL: https://github.com/mehradevesh2022/markdown-creater
- Owner: MehraDevesh2022
- Created: 2023-08-11T12:12:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-12T09:35:21.000Z (almost 2 years ago)
- Last Synced: 2025-02-03T23:31:38.791Z (3 months ago)
- Topics: browser-api, markdown-editor, markdown-viewer, mini-project, open-source, react-editor, react-markdown, react-mde, react-showdown, reactjs, resume-project, showdown-js, text-editor
- Language: JavaScript
- Homepage: https://markdown-creater.onrender.com/
- Size: 806 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown Writer
Markdown Writer is a React app that allows you to create, edit, and manage your Markdown notes in a user-friendly interface.
## Features
- Create and manage Markdown notes.
- Split pane interface with sidebar and editor for a seamless experience.
- Real-time Markdown preview using the `react-mde` library.
- Delete notes you no longer need.
- Easy-to-use interface for both experienced and new Markdown users.
## Demo
### Landing Page
### Create a New Note
### Edit a Note
### Preview a Note
## Installation and Usage
To run the Markdown Writer app on your local machine, follow these steps:
1. Clone this repository to your local machine:
```sh
git clone https://github.com/MehraDevesh2022/markdown-creater.git
```
2. Navigate to the project directory:
```sh
cd markdown-writer
```
3. Install the project dependencies:
```sh
npm install
```
4. Start the app:
```sh
npm start
```
5. Open your web browser and go to `http://localhost:3000` to start using the Markdown Writer app.
## Technologies Used
- React: A JavaScript library for building user interfaces.
- react-mde: A Markdown editor built for React applications.
- Showdown: A Markdown to HTML converter.
## Contributing
Contributions are welcome! If you find any issues or want to enhance the app, feel free to submit a pull request.