Home

Awesome

<h1 align="center"> Markdown Preview Enhanced </h1>

⚠️ Note:

This repository is now only used for hosting the documentation of Markdown Preview Enhanced.
The source code of the VSCode extension has been moved to shd101wyy/vscode-markdown-preview-enhanced.
If you are posting issues or feature requests related to the VSCode extension, please post them at shd101wyy/vscode-markdown-preview-enhanced.

intro

<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://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced">vscode</a> </p> & <a href="https://vscode.dev">vscode.dev</a> </p>

If you are interested, please also try out our new prototype web app: 0xGG/crossnote

Supporting this project

Markdown Preview Enhanced is an open source project released under the University of Illinois/NCSA Open Source License. Its ongoing development is made possible thanks to the support by these awesome backers. You can help make this project better by supporting us on GitHub Sponsors, PayPal, or 微信支付 Wechat Pay. 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 and 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, mermaid, PlantUML, pandoc, PDF export, code chunk, presentation writer, etc. A lot of its ideas are inspired by Markdown Preview Plus and RStudio Markdown.

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

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

Keybindings

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

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

Please visit https://github.com/shd101wyy/vscode-markdown-preview-enhanced/releases

License

University of Illinois/NCSA Open Source License