mirror of https://github.com/marktext/marktext.git synced 2025-05-03 00:51:26 +08:00

📝A simple and elegant markdown editor, available for Linux, macOS and Windows.

dark-mode editor electron element-ui emoji focus-mode latex linux mac macos markdown marktext next-generation source-code typewriter-mode vue windows

Go to file

冉四夕 30caf53d08 List item marker (#290 ) * add bullet list marker to preference file * list marker * update change log * update change log * code style and remove debug codes		2018-05-22 10:19:37 +08:00
.electron-vue	bug: fix codemirror loadmode didn\'t work in production environment	2017-11-22 10:57:37 +08:00
.github	List item marker (#290 )	2018-05-22 10:19:37 +08:00
build	fix: #190 Delete user settings on uninstall (NSIS) (#203 )	2018-04-22 18:57:10 +08:00
dist	first commit	2017-11-13 00:05:57 +08:00
doc	update readme	2018-05-21 13:34:17 +08:00
src	List item marker (#290 )	2018-05-22 10:19:37 +08:00
static	List item marker (#290 )	2018-05-22 10:19:37 +08:00
test	first commit	2017-11-13 00:05:57 +08:00
.babelrc	test travis	2018-03-13 10:48:47 +08:00
.eslintignore	opti:title bar and task list checkbox style optimization	2018-02-28 16:00:10 +08:00
.eslintrc.js	first commit	2017-11-13 00:05:57 +08:00
.gitignore	fix: #190 Delete user settings on uninstall (NSIS) (#203 )	2018-04-22 18:57:10 +08:00
.travis.yml	Bugfix: Can not display math block in exported HTML and PDF	2018-04-01 10:31:02 +08:00
appveyor.yml	first commit	2017-11-13 00:05:57 +08:00
LICENSE	opti: optimization the table tool bar style and float box style	2018-02-26 18:36:27 +08:00
package-lock.json	update electron-builder	2018-05-17 16:10:55 +08:00
package.json	update electron-builder	2018-05-17 16:10:55 +08:00
README.md	update readme	2018-05-21 13:34:17 +08:00

README.md

Mark Text

🔆Next generation markdown editor🌙

An Electron app for platforms of OS X Windows and Linux

Website | 中文 | Polski | 日本語 | Features | Downloads | Development | Contribution

_{This Markdown editor that could. Built with ❤︎ by
Jocs and

contributors}

Features

Realtime preview and use snabbdom as its 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?

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.
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.
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

Did not found your system? Go the the release page. Still not found? Open 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

macOS and Windows

Simply download and install Mark Text via setup wizard.

Linux

Please follow the Linux installation instructions.

Development

If you wish to build Mark Text yourself, please check out our developer documentation.

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.

Contribution

Mark Text is in full development, please make sure to read the Contributing Guide before making a pull request. Want to add some features to Mark Text? Refer to TODO LIST and open issues.