Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amitmerchant1990/electron-markdownify
:closed_book: A minimal Markdown editor desktop app
https://github.com/amitmerchant1990/electron-markdownify
desktop editor electron emoji hacktoberfest javascript jquery livepreview markdown markdownify nodejs
Last synced: 3 days ago
JSON representation
:closed_book: A minimal Markdown editor desktop app
- Host: GitHub
- URL: https://github.com/amitmerchant1990/electron-markdownify
- Owner: amitmerchant1990
- License: mit
- Created: 2016-04-15T13:15:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T15:33:50.000Z (4 months ago)
- Last Synced: 2025-01-02T08:08:35.717Z (10 days ago)
- Topics: desktop, editor, electron, emoji, hacktoberfest, javascript, jquery, livepreview, markdown, markdownify, nodejs
- Language: JavaScript
- Homepage: https://markdownify.js.org
- Size: 20.7 MB
- Stars: 990
- Watchers: 27
- Forks: 941
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- fucking-awesome-readme - amitmerchant1990/electron-markdownify - Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits. (Examples)
- project-awesome - amitmerchant1990/electron-markdownify - :closed_book: A minimal Markdown editor desktop app (JavaScript)
- awesome-readme - amitmerchant1990/electron-markdownify - Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits. (Examples)
- awesome-electron - electron-markdownify - A minimal Markdown editor desktop app.  (Apps / Markdown)
- awesome-readme - amitmerchant1990/electron-markdownify - Project logo. Minimalist description of what it is. GIF demo of the project. Key features. How to install guide. Credits. (Examples)
README
Markdownify
A minimal Markdown Editor desktop app built on top of Electron.
Key Features •
How To Use •
Download •
Credits •
Related •
License
## Key Features
* LivePreview - Make changes, See changes
- Instantly see what your Markdown documents look like in HTML as you create them.
* Sync Scrolling
- While you type, LivePreview will automatically scroll to the current location you're editing.
* GitHub Flavored Markdown
* Syntax highlighting
* [KaTeX](https://khan.github.io/KaTeX/) Support
* Dark/Light mode
* Toolbar for basic Markdown formatting
* Supports multiple cursors
* Save the Markdown preview as PDF
* Emoji support in preview :tada:
* App will keep alive in tray for quick usage
* Full screen mode
- Write distraction free.
* Cross platform
- Windows, macOS and Linux ready.
## How To Use
To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
```bash
# Clone this repository
$ git clone https://github.com/amitmerchant1990/electron-markdownify
# Go into the repository
$ cd electron-markdownify
# Install dependencies
$ npm install
# Run the app
$ npm start
```
> **Note**
> If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.
## Download
You can [download](https://github.com/amitmerchant1990/electron-markdownify/releases/tag/v1.2.0) the latest installable version of Markdownify for Windows, macOS and Linux.
## Emailware
Markdownify is an [emailware](https://en.wiktionary.org/wiki/emailware). Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at about anything you'd want to say about this software. I'd really appreciate it!
## Credits
This software uses the following open source packages:
- [Electron](http://electron.atom.io/)
- [Node.js](https://nodejs.org/)
- [Marked - a markdown parser](https://github.com/chjj/marked)
- [showdown](http://showdownjs.github.io/showdown/)
- [CodeMirror](http://codemirror.net/)
- Emojis are taken from [here](https://github.com/arvida/emoji-cheat-sheet.com)
- [highlight.js](https://highlightjs.org/)
## Related
[markdownify-web](https://github.com/amitmerchant1990/markdownify-web) - Web version of Markdownify
## Support
Or
## You may also like...
- [Pomolectron](https://github.com/amitmerchant1990/pomolectron) - A pomodoro app
- [Correo](https://github.com/amitmerchant1990/correo) - A menubar/taskbar Gmail App for Windows and macOS
## License
MIT
---
> [amitmerchant.com](https://www.amitmerchant.com) ·
> GitHub [@amitmerchant1990](https://github.com/amitmerchant1990) ·
> Twitter [@amit_merchant](https://twitter.com/amit_merchant)