README.md

Mark Text

Features

• Realtime preview and use snabbdom as it's render engine.
• Support CommonMark Spec and GitHub Flavored Markdown Spec.
• 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.

?Dark and Light themes?

Dark ? Light?

?Edit modes?

Source Code Typewriter Focus

Why write another editor?

1. I love writing, I have used a lot of markdown editors, there is still not a editor can fully meet my needs, I don't like to be disturbed when I write, and some unbearable bug, Mark Text use virtual DOM to render the page, So it's high efficiency, and open source to friends all 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, but we are trying to make it perfect.

Download and Install

Mark Text build for these platforms

v0.6.14 v0.6.14 v 0.6.14

Not found your system ? Go the the release page, still not found ? Shoot an issue.

Want to see new features in this version? Refer to CHANGELOG

If you use OS X system, you can install Mark Text by homebrew cask, to start using Homebrew-Cask, you just need Homebrew installed.

brew cask install mark-text

Development

If you wish to build Mark Text yourself.

• first clone this repo.
• Run npm install
• Run npm run build
• copy the build app to Applications folder, or if on Windows run the executable installer.

When you use Mark Text, if you have any questions, you are welcome to write an issue, but I hope you follow the format of issue. Of course, if you can submit a PR directly, it will be appreciated.

Contribution

Please make sure to read the Contributing Guide before making a pull request. Want to add some features to Mark Text? Reference TODO LIST

Thank you to all the people who have already contributed to Mark Text!

Jocs ywwhack notAlaanor

License

MIT.

Copyright (c) 2017-present, Jocs