Next Generation Markdown Editor

Andrew Currie dfa3976767 updated readme 1 year ago
.electron-vue 926ce7a0af bug: fix codemirror loadmode didn\'t work in production environment 1 year ago
.github 3f5ba6ff7b Update: changelog 1 year ago
build 301722f3d3 change logo: special thanks to @Yasujizr 1 year ago
dist 94ca31d58a first commit 1 year ago
doc f46d7363cd Use HTTPS instead of HTTP (#158) 1 year ago
src 7e447e7c82 fix: #161 can not select all by `Ctrl + A` when the first block is HTML Block 1 year ago
static f46d7363cd Use HTTPS instead of HTTP (#158) 1 year ago
test 94ca31d58a first commit 1 year ago
.babelrc 1762b1ab94 test travis 1 year ago
.eslintignore f30cbfd837 opti:title bar and task list checkbox style optimization 1 year ago
.eslintrc.js 94ca31d58a first commit 1 year ago
.gitignore 7f0c67d822 fix typo error 1 year ago
.travis.yml 13f4164b32 Bugfix: Can not display math block in exported HTML and PDF 1 year ago
LICENSE bfdfc7e183 opti: optimization the table tool bar style and float box style 1 year ago
README.md dfa3976767 updated readme 1 year ago
appveyor.yml 94ca31d58a first commit 1 year ago
logo-small.png acc52f5bed marktext logo 1 year ago
package-lock.json a2cc87f7cf Optimization: sanitize html to avoid XSS attack #127 (#132) 1 year ago
package.json a2cc87f7cf Optimization: sanitize html to avoid XSS attack #127 (#132) 1 year ago

README.md

mark text

Mark Text

:high_brightness:Next generation markdown editor:crescent_moon:
An Electron app for platforms of OS X Windows and Linux


<a href="https://marktext.github.io/website">
  Website
</a>
<span> | </span>
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/zh_cn.md#readme">
  中文
</a>
<span> | </span>
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/pl.md#readme">
  Polski
</a>
<span> | </span>
<a href="https://github.com/marktext/marktext#features">
  Features
</a>
<span> | </span>
<a href="https://github.com/marktext/marktext#download-and-install">
  Downloads
</a>
<span> | </span>
<a href="https://github.com/marktext/marktext#development">
  Development
</a>
<span> | </span>
<a href="https://github.com/marktext/marktext#contribution">
  Contribution
</a>


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.

:crescent_moon:Dark and Light themes:high_brightness:

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

Conda

latest version latest version latest version

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

Thank you to all the people who have already contributed to Mark Text! If you are a member of contributors, open a PR to add your name and photo to the contribution list below.

Special thanks to @Yasujizr who designed the logo of Mark Text.

Jocs ywwhack notAlaanor fxha
Jocs ywwhack notAlaanor fxha

License

MIT.

Copyright (c) 2017-present, @Jocs