Skip to content

xu4wang/markdown-preview-enhanced

 
 

Repository files navigation

Markdown Preview Enhanced


intro

English    简体中文    繁體中文    日本語    한국어   

atom & vscode

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


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.
Learn More



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 cmd key for Windows is ctrl.

Shortcuts Functionality
ctrl-shift-m Toggle preview
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

Newest updates for the current minor version can be found at the newest notes. Detailed changes for each old release can be found at history notes.

License

University of Illinois/NCSA Open Source License

About

'Best' markdown preview for atom editor

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 88.9%
  • TypeScript 9.8%
  • Nix 0.9%
  • JavaScript 0.2%
  • Less 0.1%
  • CSS 0.1%