https://github.com/esausilva/live-markdown-editor
GitHub flavored markdown editor built with React.js
https://github.com/esausilva/live-markdown-editor
markdown-editor markdown-to-html react
Last synced: 4 months ago
JSON representation
GitHub flavored markdown editor built with React.js
- Host: GitHub
- URL: https://github.com/esausilva/live-markdown-editor
- Owner: esausilva
- License: mit
- Created: 2017-01-08T15:00:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T19:52:42.000Z (over 2 years ago)
- Last Synced: 2024-04-14T13:13:14.664Z (about 1 year ago)
- Topics: markdown-editor, markdown-to-html, react
- Language: JavaScript
- Homepage: https://esausilva.github.io/live-markdown-editor/
- Size: 12 MB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Live Markdown Editor
> Responsive GitHub flavored markdown editor built with [React.js](https://facebook.github.io/react/)
You can use this editor to preview your markdown files before committing to GitHub.
## Local Installation
Clone this repo, or download it into a directory of your choice then:
```bash
$ npm install -g create-react-app
$ npm install
```
## Live Demo
[https://esausilva.github.io/live-markdown-editor/](https://esausilva.github.io/live-markdown-editor/)
## Useful Info
- Download the markdown file by pressing **Ctrl+m**
- Empty editor window by pressing **Ctrl+Shift+e**
- [Emojis](http://www.webpagefx.com/tools/emoji-cheat-sheet/) are cool :thumbsup: :poop: :sunny: :alien:
- Drag and Drop a markdown file to editor
- Click on this icon  on the bottom right corner to browse and open a markdown file (not working at the moment dues to Hooks Rewrite)
## Projects Used
- [CodeMirror](https://codemirror.net/) - The code editor
- [marked](https://github.com/chjj/marked) - The markdown parser
- [highlight.js](https://highlightjs.org/) - The syntax highlighter in markdown the output
- [emojify.js](https://github.com/emojione/emojify.js/) - Emoji support
## License
MIT © 2018 Esau Silva