One of the 'BEST' markdown preview extensions for Atom editor!
<h1 align="center"> Markdown Preview Enhanced </h1>
<p align="center">
<a href="https://github.com/shd101wyy/markdown-preview-enhanced/releases"><img src="https://img.shields.io/github/tag/shd101wyy/markdown-preview-enhanced.svg"></a>
<a href="https://github.com/shd101wyy/markdown-preview-enhanced"><img src="https://img.shields.io/apm/dm/markdown-preview-enhanced.svg"></a>
<a href="https://github.com/shd101wyy/markdown-preview-enhanced"><img src="https://img.shields.io/github/stars/shd101wyy/markdown-preview-enhanced.svg?style=social&label=Star"></a>
</p>
<br>

![intro](https://user-images.githubusercontent.com/1908863/28227953-eb6eefa4-68a1-11e7-8769-96ea83facf3b.png)

<p align="center">
<a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/"> English &nbsp;&nbsp; </a>
<a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-cn/"> 简体中文 &nbsp;&nbsp; </a>
<a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-tw/"> 繁體中文 &nbsp;&nbsp; </a>
<a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/ja-jp/"> 日本語 &nbsp;&nbsp; </a> 
<a href="https://shd101wyy.github.io/markdown-preview-enhanced/#/ko-kr/"> 한국어 &nbsp;&nbsp; </a> 
<br>
</p>

<p align="center">
<a href="https://atom.io/packages/markdown-preview-enhanced">atom</a>
&
<a href="https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced">vscode</a>
</p>

If you are interested, please also try out our new prototype web app: [0xGG/crossnote](https://github.com/0xGG/crossnote)

## Supporting this project

Markdown Preview Enhanced is an open source project released under the [University of Illinois/NCSA Open Source License](LICENSE.md). Its ongoing development is made possible thanks to the support by these awesome [backers](https://shd101wyy.github.io/markdown-preview-enhanced/#/backers). You can help make this project better by [supporting us on GitHub Sponsors](https://github.com/sponsors/shd101wyy), [PayPal](https://shd101wyy.github.io/markdown-preview-enhanced/#/paypal), or [微信支付 Wechat Pay](https://shd101wyy.github.io/markdown-preview-enhanced/#/wechat). Thank you!

## Sponsors

<p><a title="Try CodeStream" href="https://sponsorlink.codestream.com/?utm_source=vscmarket&amp;utm_campaign=shd101wyy-markdown&amp;utm_medium=banner"><img src="https://alt-images.codestream.com/codestream_logo_shd101wyy-markdown.png"></a></br>
Manage pull requests and conduct code reviews in your IDE with full source-tree context. Comment on any line, not just the diffs. Use jump-to-definition, your favorite keybindings, and code intelligence with more of your workflow.<br> <a title="Try CodeStream" href="https://sponsorlink.codestream.com/?utm_source=vscmarket&amp;utm_campaign=shd101wyy-markdown&amp;utm_medium=banner">Learn More</a></p>

<br>

<a href="https://github.com/sponsors/shd101wyy">
  <img src="https://github.blog/wp-content/uploads/2019/05/mona-heart-featured.png?" width="200"></a><br>

These [GitHub Sponsors](https://github.com/sponsors/shd101wyy#sponsors) and [Backers](https://shd101wyy.github.io/markdown-preview-enhanced/#/backers) help push this project forward 🎉.

## Introduction

Markdown Preview Enhanced is an extension that provides you with many useful functionalities such as automatic scroll sync, [math typesetting](https://shd101wyy.github.io/markdown-preview-enhanced/#/math), [mermaid](https://shd101wyy.github.io/markdown-preview-enhanced/#/diagrams?id=mermaid), [PlantUML](https://shd101wyy.github.io/markdown-preview-enhanced/#/diagrams?id=plantuml), [pandoc](https://shd101wyy.github.io/markdown-preview-enhanced/#/pandoc), PDF export, [code chunk](https://shd101wyy.github.io/markdown-preview-enhanced/#/code-chunk), [presentation writer](https://rawgit.com/shd101wyy/markdown-preview-enhanced/master/docs/presentation-intro.html), etc. A lot of its ideas are inspired by [Markdown Preview Plus](https://github.com/atom-community/markdown-preview-plus) and [RStudio Markdown](http://rmarkdown.rstudio.com/).

Feel free to ask questions, post issues, submit pull request, and request new features.

For more information about this project and how to use this extension, please check out our documentation ⬇︎

## Documentation

To check out the documentation, visit

- [English](https://shd101wyy.github.io/markdown-preview-enhanced/#/)
- [简体中文](https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-cn/)
- [繁體中文](https://shd101wyy.github.io/markdown-preview-enhanced/#/zh-tw/)
- [日本語](https://shd101wyy.github.io/markdown-preview-enhanced/#/ja-jp/)
- [한국어](https://shd101wyy.github.io/markdown-preview-enhanced/#/ko-kr/)

Contact me if you are willing to help translate the documentation :)

## Keybindings

> The <kbd>cmd</kbd> key for _Windows_ is <kbd>ctrl</kbd>.

| Shortcuts                                   | Functionality              |
| ------------------------------------------- | -------------------------- |
| <kbd>ctrl-shift-m</kbd>                     | Toggle preview             |
| <kbd>ctrl-shift-s</kbd>                     | Sync preview / Sync source |
| <kbd>shift-enter</kbd>                      | Run Code Chunk             |
| <kbd>ctrl-shift-enter</kbd>                 | Run all Code Chunks        |
| <kbd>cmd-=</kbd> or <kbd>cmd-shift-=</kbd>  | Preview zoom in            |
| <kbd>cmd--</kbd> or <kbd>cmd-shift-\_</kbd> | Preview zoom out           |
| <kbd>cmd-0</kbd>                            | Preview reset zoom         |
| <kbd>esc</kbd>                              | Toggle sidebar TOC         |

## Changelog

Newest updates for the current minor version can be found at the [newest notes](https://shd101wyy.github.io/markdown-preview-enhanced/#/newest).
Detailed changes for each old release can be found at [history notes](https://shd101wyy.github.io/markdown-preview-enhanced/#/history).

## License

[University of Illinois/NCSA Open Source License](LICENSE.md)
