github/marktext
5
0
Fork 0
mirror of https://github.com/marktext/marktext.git synced 2025-05-04 17:52:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
306 Commits 5 Branches 36 Tags 82 MiB
JavaScript 76.6%
Vue 15.8%
CSS 7.3%
EJS 0.2%
1bedd1a21e
Go to file
Charlie Robbins 1bedd1a21e Fix "Downloads" in README.md (#60) 
* [fix doc] Correct anchor for "Downloads"

* [tiny doc] Link to #readme on Markdown pages for better vertical centering.
2018-03-23 11:58:51 +08:00
.electron-vue bug: fix codemirror loadmode didn\'t work in production environment 2017-11-22 10:57:37 +08:00
.github fix the crash 2018-03-21 18:27:36 +08:00
build/icons change logo: special thanks to @Yasujizr 2018-03-22 01:32:10 +08:00
dist first commit 2017-11-13 00:05:57 +08:00
doc change "流程" to "流畅" 2018-03-19 12:20:56 +08:00
src Add swift syntax highlighting (#57) 2018-03-22 23:44:12 +08:00
static change logo: special thanks to @Yasujizr 2018-03-22 01:32:10 +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 typo error 2017-12-22 18:04:50 +08:00
.travis.yml add Chinese readme 2018-03-14 18:32:17 +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 bugfix: little bug in typewriter mode 2018-03-20 16:20:02 +08:00
package.json feat: user preference and fix issues #45 #16 2018-03-21 17:11:18 +08:00
README.md Fix "Downloads" in README.md (#60) 2018-03-23 11:58:51 +08:00

README.md

mark text

Mark Text

🔆Next generation markdown editor🌙
An Electron app for platforms of OS X Windows and Linux

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

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 Conda
latest version latest version latest version

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

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 contributor in contributors, Open a PR to add you name and photo to the contribution list bellow.

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

Jocs ywwhack notAlaanor
Jocs ywwhack notAlaanor

License

MIT.

Copyright (c) 2017-present, Jocs