Mark Text
:high_brightness:Next generation markdown editor:crescent_moon:
An Electron app for platforms of OS X Windows and Linux
## Features
- Realtime preview and use [snabbdom](https://github.com/snabbdom/snabbdom) as its render engine.
- Support [CommonMark Spec](https://spec.commonmark.org/0.28/) and [GitHub Flavored Markdown Spec](https://github.github.com/gfm/).
- Support paragraphs and inline style shortcuts to improve your writing efficiency.
- Output **HTML** and **PDF** file.
- Dark and Light themes.
- Various edit mode: **Source Code mode**, **Typewriter mode**, **Focus mode**.
:crescent_moon:Dark and Light themes:high_brightness:
| Dark :crescent_moon: | Light :high_brightness: |
|:------------------------------------------------------------------:|:-------------------------------------------------------------------:|
|  |  |
:smile_cat:Edit modes:dog:
| Source Code | Typewriter | Focus |
|:--------------------------------------------------------------------:|:------------------------------------------------------------------------:|:-------------------------------------------------------------------:|
|  |  |  |
## Why write another editor?
1. I love writing. I have used a lot of markdown editors, yet there is still not an editor that can fully meet my needs. I don't like to be disturbed when I write by some unbearable bug. **Mark Text** uses virtual DOM to render the page, so it's high efficiency, and open source to all friends who love markdown and writing.
2. As mentioned above, **Mark Text** will be open source forever. It is also hoped that all markdown lovers can contribute their own code, and develop **Mark Text** into a popular markdown editor.
3. There are many markdown editors, and each editor has its own characteristics, but it is also difficult to satisfy all markdown users' needs. I hope **Mark Text** can satisfy markdown users' needs as much as possible. Although the latest **Mark Text** is still not perfect, we are trying to make it as perfect as we can.
## Download and Install
|  |  |  |
|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [](https://github.com/marktext/marktext/releases/download/v0.12.25/marktext-0.12.25.dmg) | [](https://github.com/marktext/marktext/releases/download/v0.12.25/marktext-setup-0.12.25.exe) | [](https://github.com/marktext/marktext/releases/download/v0.12.25/marktext-0.12.25-x86_64.AppImage) |
Can't find your system? Go the the [release page](https://github.com/marktext/marktext/releases). Still can't find? Open an [issue](https://github.com/marktext/marktext/issues).
Want to see new features in this version? Refer to [CHANGELOG](https://github.com/marktext/marktext/blob/master/.github/CHANGELOG.md)
If you use OS X system, you can install Mark Text by [**homebrew cask**](https://github.com/caskroom/homebrew-cask), to start using Homebrew-Cask, you just need [Homebrew](https://brew.sh/) installed.
```bash
brew cask install mark-text
```
#### macOS and Windows
Simply download and install Mark Text via setup wizard.
#### Linux
Please follow the [Linux installation instructions](https://github.com/marktext/marktext/blob/master/doc/linux.md).
## Development
If you wish to build **Mark Text** yourself, please check out our [developer documentation](https://github.com/marktext/marktext/blob/master/.github/CONTRIBUTING.md#build-instructions).
When you have any questions while using **Mark Text**, you are welcome to write an issue, but I hope you will follow the format of issue. Of course, if you submit a PR directly, it will be appreciated.
## Integrations
- [Alfred Workflow](http://www.packal.org/workflow/mark-text): A Workflow for the OS X app Alfred: Use "mt" to open files/folder with Mark Text.
## Contribution
Mark Text is in full development, please make sure to read the [Contributing Guide](https://github.com/marktext/marktext/blob/master/.github/CONTRIBUTING.md) before making a pull request. Want to add some features to Mark Text? Refer to [TODO LIST](https://github.com/marktext/marktext/blob/master/.github/TODOLIST.md) and open issues.
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/marktext#backers)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/marktext#silver-sponsors)]
**Platinum Sponsors**
## Contributors
Thank you to all the people who have already contributed to Mark Text[[contributors](https://github.com/marktext/marktext/graphs/contributors)]
Special thanks to @[Yasujizr](https://github.com/Yasujizr) who designed the logo of Mark Text.
## License
[**MIT**](https://github.com/marktext/marktext/blob/master/LICENSE).
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fmarktext%2Fmarktext?ref=badge_large)
