mirror of
https://github.com/marktext/marktext.git
synced 2025-05-02 23:12:45 +08:00
232 lines
12 KiB
Markdown
232 lines
12 KiB
Markdown
|
|
<p align="center"><img src="https://github.com/marktext/marktext/blob/master/static/logo-small.png" alt="mark text" width="100" height="100"></p>
|
|
|
|
<h1 align="center">Mark Text</h1>
|
|
|
|
<div align="center">
|
|
<a href="https://twitter.com/intent/tweet?via=marktextme&url=https://github.com/marktext/marktext/&text=What%20do%20you%20want%20to%20say%20to%20me?&hashtags=happyMarkText">
|
|
<img src="https://img.shields.io/twitter/url/https/github.com/marktext/marktext.svg?style=for-the-badge" alt="twitter">
|
|
</a>
|
|
</div>
|
|
<div align="center">
|
|
<strong>:high_brightness:Next generation markdown editor:crescent_moon:</strong>
|
|
</div>
|
|
<div align="center">
|
|
An <code>Electron</code> app for platforms of macOS, Windows and Linux
|
|
</div>
|
|
|
|
<br />
|
|
|
|
<div align="center">
|
|
<!-- Version -->
|
|
<a href="https://marktext.github.io/website">
|
|
<img src="https://badge.fury.io/gh/jocs%2Fmarktext.svg" alt="website">
|
|
</a>
|
|
<!-- License -->
|
|
<a href="https://github.com/marktext/marktext/blob/master/LICENSE">
|
|
<img src="https://img.shields.io/github/license/marktext/marktext.svg" alt="LICENSE">
|
|
</a>
|
|
<!-- Build Status -->
|
|
<a href="https://travis-ci.org/marktext/marktext/">
|
|
<img src="https://travis-ci.org/marktext/marktext.svg?branch=master" alt="build">
|
|
</a>
|
|
<a href="https://ci.appveyor.com/project/marktext/marktext/branch/master">
|
|
<img src="https://ci.appveyor.com/api/projects/status/l4gxgydj0i95hmxg/branch/master?svg=true" alt="build">
|
|
</a>
|
|
<!-- Downloads total -->
|
|
<a href="https://github.com/marktext/marktext/releases">
|
|
<img src="https://img.shields.io/github/downloads/marktext/marktext/total.svg" alt="total download">
|
|
</a>
|
|
<!-- Downloads latest release -->
|
|
<a href="https://github.com/marktext/marktext/releases/latest">
|
|
<img src="https://img.shields.io/github/downloads/marktext/marktext/v0.13.65/total.svg" alt="latest download">
|
|
</a>
|
|
<!-- sponsors -->
|
|
<a href="https://opencollective.com/marktext">
|
|
<img src="https://opencollective.com/marktext/tiers/silver-sponsors/badge.svg?label=SilverSponsors&color=brightgreen" alt="sponsors">
|
|
</a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<h3>
|
|
<a href="https://marktext.github.io/website">
|
|
Website
|
|
</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>
|
|
</h3>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<sub>Translations:</sub>
|
|
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/zh_cn.md#readme">
|
|
<span>:cn:</span>
|
|
</a>
|
|
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/pl.md#readme">
|
|
<span>:poland:</span>
|
|
</a>
|
|
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/ja.md#readme">
|
|
<span>:jp:</span>
|
|
</a>
|
|
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/french.md#readme">
|
|
<span>:fr:</span>
|
|
</a>
|
|
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/tr.md#readme">
|
|
<span>:tr:</span>
|
|
</a>
|
|
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/spanish.md#readme">
|
|
<span>:es:</span>
|
|
</a>
|
|
<a href="https://github.com/marktext/marktext/blob/master/doc/i18n/pt.md#readme">
|
|
<span>:portugal:</span>
|
|
</a>
|
|
</div>
|
|
|
|
<div align="center">
|
|
<sub>This Markdown editor that could. Built with ❤︎ by
|
|
<a href="https://github.com/Jocs">Jocs</a> and
|
|
<a href="https://github.com/marktext/marktext/graphs/contributors">
|
|
contributors
|
|
</a>
|
|
</sub>
|
|
</div>
|
|
|
|
<br />
|
|
|
|
|
|
|
|
## 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** files.
|
|
- Dark and Light themes.
|
|
- Various editing modes: **Source Code mode**, **Typewriter mode**, **Focus mode**.
|
|
|
|
<h4 align="center">:crescent_moon:Dark and Light themes:high_brightness:</h4>
|
|
|
|
| Dark :crescent_moon: | Light :high_brightness: |
|
|
|:------------------------------------------------------------------:|:-------------------------------------------------------------------:|
|
|
|  |  |
|
|
|
|
<h4 align="center">:smile_cat:Edit modes:dog:</h4>
|
|
|
|
| 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 pages which has the added benefits of being highly efficient and being open source. That way anyone who loves markdown and writing can use Mark Text.
|
|
2. As mentioned above, **Mark Text** is open source and will be open source forever. We hope that all markdown lovers will contribute their own code and help develop **Mark Text** into a popular markdown editor.
|
|
3. There are many markdown editors and all have their own merits, some have feautures which others don't. It's difficult to satisfy each markdown users needs but we hope **Mark Text** will be able to satisfy each markdown users' needs as much as possible. Although the latest **Mark Text** is still not perfect, we will try to make it as best as we possibly can.
|
|
|
|
## Download and Install
|
|
|
|
|
|
|
|
|  |  |  |
|
|
|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
| [](https://github.com/marktext/marktext/releases/download/v0.13.65/marktext-0.13.65.dmg) | [](https://github.com/marktext/marktext/releases/download/v0.13.65/marktext-setup-0.13.65.exe) | [](https://github.com/marktext/marktext/releases/download/v0.13.65/marktext-0.13.65-x86_64.AppImage) |
|
|
|
|
Can't find your system? Go to the [release page](https://github.com/marktext/marktext/releases/latest). Is a version for your system unavailable? Than open an [issue](https://github.com/marktext/marktext/issues).
|
|
|
|
Want to see new features of the latest version? Refer to [CHANGELOG](https://github.com/marktext/marktext/blob/master/.github/CHANGELOG.md)
|
|
|
|
If you use macOS, you can install Mark Text using [**homebrew cask**](https://github.com/caskroom/homebrew-cask). To use Homebrew-Cask you just need to have [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).
|
|
|
|
If you have any questions regarding **Mark Text**, you are welcome to write an issue. When doing so please use the default format found when opening a issue. Of course, if you submit a PR directly, it will be greatly appreciated.
|
|
|
|
## Integrations
|
|
|
|
- [Alfred Workflow](http://www.packal.org/workflow/mark-text): A Workflow for the macOS 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.
|
|
|
|
## 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#platinum-sponsors)]
|
|
|
|
**Platinum Sponsors**
|
|
|
|
<a href="https://readme.io" target="_blank"><img src="https://github.com/marktext/marktext/blob/master/doc/sponsor/readme.png" /></a>
|
|
<a href="https://opencollective.com/marktext#platinum-sponsors">
|
|
<img src="https://opencollective.com/marktext/tiers/platinum-sponsors.svg?avatarHeight=36&width=600">
|
|
</a>
|
|
|
|
**Gold Sponsors**
|
|
|
|
<a href="https://opencollective.com/marktext#platinum-sponsors">
|
|
<img src="https://opencollective.com/marktext/tiers/gold-sponsors.svg?avatarHeight=36&width=600">
|
|
</a>
|
|
|
|
**Silver Sponsors**
|
|
|
|
<a href="https://opencollective.com/marktext#platinum-sponsors">
|
|
<img src="https://opencollective.com/marktext/tiers/silver-sponsors.svg?avatarHeight=36&width=600">
|
|
</a>
|
|
|
|
**Bronze Sponsors**
|
|
|
|
<a href="https://opencollective.com/marktext#platinum-sponsors">
|
|
<img src="https://opencollective.com/marktext/tiers/bronze-sponsors.svg?avatarHeight=36&width=600">
|
|
</a>
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/marktext#backers)]
|
|
|
|
<a href="https://opencollective.com/marktext#backers">
|
|
<img src="https://opencollective.com/marktext/tiers/backer.svg?avatarHeight=36&width=600">
|
|
</a>
|
|
|
|
## 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.
|
|
|
|
<a href="https://github.com/marktext/marktext/graphs/contributors"><img src="https://opencollective.com/marktext/contributors.svg?width=890" /></a>
|
|
|
|
|
|
## License
|
|
|
|
[**MIT**](https://github.com/marktext/marktext/blob/master/LICENSE).
|
|
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fmarktext%2Fmarktext?ref=badge_large)
|