marktext

marktext/marktext

<p align="center"><img src="docs/assets/logo-small.png" alt="MarkText" width="100" height="100"></p> <h1 align="center">MarkText</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%20app?&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><br> A simple and elegant open-source markdown editor that focused on speed and usability.<br> _{Available for Linux, macOS and Windows.} </div> <br> <div align="center"> <!-- License --> <a href="LICENSE"> <img src="https://img.shields.io/github/license/marktext/marktext.svg" alt="LICENSE"> </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/latest/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://github.com/marktext/marktext"> 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-installation"> 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"> _{Translations:} <a href="docs/i18n/README-zh_cn.md#readme"> <span>:cn:</span> </a> <a href="docs/i18n/README-zh_tw.md#readme"> <span>:taiwan:</span> </a> <a href="docs/i18n/README-jp.md#readme"> <span>:jp:</span> </a> <a href="docs/i18n/README-fr.md#readme"> <span>:fr:</span> </a> <a href="docs/i18n/README-tr.md#readme"> <span>:tr:</span> </a> <a href="docs/i18n/README-es.md#readme"> <span>:es:</span> </a> <a href="docs/i18n/README-pt.md#readme"> <span>:portugal:</span> </a> <a href="docs/i18n/README-kr.md#readme"> <span>:kr:</span> </a> </div> <div align="center"> _{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> .} </div> <br /> <h2 align="center">Sponsors</h2> MarkText is an open-source Markdown editor powered by the support of its community. If MarkText improves your workflow, please consider [sponsoring the project](https://github.com/sponsors/marktext). Thank you to all the sponsors ❤️ **Special Sponsor** | [<img src="docs/assets/sponsors/serpapi.png" width="150">](https://serpapi.com/?utm_source=marktext) | [Scrape Google and other search engines from our fast, easy, and complete API.](https://serpapi.com/?utm_source=marktext) | | ------------- |:-------------| ## Screenshot  ## Features - Realtime preview (WYSIWYG) and a clean and simple interface to get a distraction-free writing experience. - Support [CommonMark Spec](https://spec.commonmark.org), [GitHub Flavored Markdown Spec](https://github.github.com/gfm/) and selective support [Pandoc markdown](https://pandoc.org/MANUAL.html#pandocs-markdown). - Markdown extensions such as math expressions (KaTeX), front matter and emojis. - Support paragraphs and inline style shortcuts to improve your writing efficiency. - Output **HTML** and **PDF** files. - Various [themes](https://marktext.me/docs/themes): **Cadmium Light**, **Material Dark** etc. - Various editing modes: **Source Code mode**, **Typewriter mode**, **Focus mode**. - Paste images directly from clipboard. ## Download and Installation  |  |  |  | |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | [](https://github.com/marktext/marktext/releases/latest) | [](https://github.com/marktext/marktext/releases/latest) | [](https://github.com/marktext/marktext/releases/latest) | Want to see new features of the latest version? Please refer to [CHANGELOG](https://marktext.me/docs/changelog). #### macOS Requires macOS 11 (Big Sur) or later. Universal builds aren't published — pick the matching `arm64` or `x64` installer. You can either download the latest `marktext-mac-(arm64|x64)-%version%.dmg` from the [release page](https://github.com/marktext/marktext/releases/latest) or install MarkText 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 install --cask mark-text ``` #### Windows Requires Windows 10 or 11. Both x64 and arm64 installers are published — pick the architecture that matches your machine. Simply download and install MarkText via the setup wizard (`marktext-win-(x64|arm64)-%version%-setup.exe`) and choose whether to install per-user or machine wide. Alternatively, install MarkText using a package manager such as [Chocolatey](https://chocolatey.org/) or [Winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/). To use Chocolatey, you need to have [Chocolatey](https://chocolatey.org/install) installed: ```bash choco install marktext ``` To use Winget, you need to have [Winget](https://docs.microsoft.com/en-us/windows/package-manager/winget/#install-winget) installed: ```bash winget install marktext ``` #### Linux Please follow the [Linux installation instructions](https://marktext.me/docs/installation). #### Other All binaries for Linux, macOS and Windows can be downloaded from the [release page](https://github.com/marktext/marktext/releases/latest). If a version is unavailable for your system, then please open an [issue](https://github.com/marktext/marktext/issues). ## Development If you wish to build MarkText yourself, please check out our [build instructions](https://marktext.me/docs/dev/build). - [User documentation](https://marktext.me/docs/introduction) - [Developer documentation](https://marktext.me/docs/dev/overview) If you have any questions regarding MarkText, you are welcome to write an issue. When doing so please use the default format found when opening an issue. Of course, if you submit a PR directly, it will be greatly appreciated. ## Contribution MarkText is in development, please make sure to read the [Contributing Guide](.github/CONTRIBUTING.md) before making a pull request. Want to add some features to MarkText? Refer to our [roadmap](https://github.com/marktext/marktext/projects) and open issues. ## Contributors Thank you to all the people who have already contributed to MarkText[[contributors](https://github.com/marktext/marktext/graphs/contributors)]. <a href="https://github.com/marktext/marktext/graphs/contributors"><img src="https://opencollective.com/marktext/contributors.svg?width=890" /></a> ## License [**MIT**](LICENSE).