https://github.com/shd101wyy/vscode-markdown-preview-enhanced
One of the "BEST" markdown preview extensions for Visual Studio Code
https://github.com/shd101wyy/vscode-markdown-preview-enhanced
markdown vscode-extension
Last synced: 11 days ago
JSON representation
One of the "BEST" markdown preview extensions for Visual Studio Code
- Host: GitHub
- URL: https://github.com/shd101wyy/vscode-markdown-preview-enhanced
- Owner: shd101wyy
- License: other
- Created: 2017-06-10T19:20:04.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2026-05-24T15:39:22.000Z (23 days ago)
- Last Synced: 2026-05-30T19:04:24.517Z (17 days ago)
- Topics: markdown, vscode-extension
- Language: TypeScript
- Homepage: https://shd101wyy.github.io/markdown-preview-enhanced
- Size: 12.4 MB
- Stars: 1,963
- Watchers: 26
- Forks: 238
- Open Issues: 1,405
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Agents: AGENTS.md
Awesome Lists containing this project
- awesome-list - vscode-markdown-preview-enhanced
- awesome - shd101wyy/vscode-markdown-preview-enhanced - One of the "BEST" markdown preview extensions for Visual Studio Code (TypeScript)
README
Markdown Preview Enhanced
[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/) · [Français](https://shd101wyy.github.io/markdown-preview-enhanced/#/fr-fr/) · [Español](https://shd101wyy.github.io/markdown-preview-enhanced/#/es-es/) · [Português](https://shd101wyy.github.io/markdown-preview-enhanced/#/pt-br/) · [Nederlands](https://shd101wyy.github.io/markdown-preview-enhanced/#/nl-nl/) · [Türkçe](https://shd101wyy.github.io/markdown-preview-enhanced/#/tr-tr/)
[VS Code](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) · [VS Code for the Web](https://vscode.dev)
## 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
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), [WebSequenceDiagrams](https://www.websequencediagrams.com), [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 ⬇︎
## Privacy
**This extension does not collect, transmit, or share your data with any external service.** The core preview, scroll sync, math typesetting, diagram rendering, and all editor features run entirely on your local machine. No telemetry, no tracking, no phone-home.
- **Markdown content** — rendered locally; never leaves your machine.
- **Math (KaTeX/MathJax)** — typeset locally or via a CDN JavaScript library you configure (default: jsdelivr).
- **Diagrams (Mermaid, Graphviz, Vega, WaveDrom, D2, TikZ)** — rendered locally using bundled or system-installed tools.
- **PlantUML** — rendered via your own PlantUML server (`plantumlServer` config) or a local `.jar` file. Unless explicitly configured to use `kroki.io`, no diagram data is sent to any remote service.
- **Image upload (imgur, sm.ms, qiniu)** — opt-in only. Requires you to manually trigger the upload and configure API credentials.
- **Pandoc / ebook / PDF export** — uses locally installed tools; no data is uploaded.
If you have any questions about data handling, please [open an issue](https://github.com/shd101wyy/vscode-markdown-preview-enhanced/issues).
## 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/)
- [Français](https://shd101wyy.github.io/markdown-preview-enhanced/#/fr-fr/)
- [Español](https://shd101wyy.github.io/markdown-preview-enhanced/#/es-es/)
- [Português](https://shd101wyy.github.io/markdown-preview-enhanced/#/pt-br/)
- [Nederlands](https://shd101wyy.github.io/markdown-preview-enhanced/#/nl-nl/)
- [Türkçe](https://shd101wyy.github.io/markdown-preview-enhanced/#/tr-tr/)
Contact me if you are willing to help translate the documentation :)
## Keybindings
> The cmd key for _Windows_ is ctrl.
| Shortcuts | Functionality |
| -------------------------------------------------------------- | ------------------------------- |
| cmd-k v or ctrl-k v | Open preview to the Side |
| cmd-shift-v or ctrl-shift-v | Open preview |
| cmd-k shift-l or ctrl-k shift-l | Open locked preview to the Side |
| cmd-k cmd-shift-l or ctrl-k ctrl-shift-l | Toggle preview lock |
| ctrl-shift-s | Sync preview / Sync source |
| shift-enter | Run Code Chunk |
| ctrl-shift-enter | Run all Code Chunks |
| cmd-= or cmd-shift-= | Preview zoom in |
| cmd-- or cmd-shift-\_ | Preview zoom out |
| cmd-0 | Preview reset zoom |
| esc | Toggle sidebar TOC |
## Changelog
Please check the [Releases](https://github.com/shd101wyy/vscode-markdown-preview-enhanced/releases) page of this project.
## License
[University of Illinois/NCSA Open Source License](LICENSE.md)