# markdown-preview-enhanced
**Repository Path**: mirsking/markdown-preview-enhanced
## Basic Information
- **Project Name**: markdown-preview-enhanced
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: NCSA
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-12-20
- **Last Updated**: 2024-05-29
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
Markdown Preview Enhanced
===
Still Beta Version!
[](https://github.com/shd101wyy/markdown-preview-enhanced/releases)  [](https://github.com/shd101wyy/markdown-preview-enhanced)
[中文文档](./docs/README_CN.md)
Post [here](https://github.com/shd101wyy/markdown-preview-enhanced/issues) if you request new features or you want to report bugs ;)
(TOC below was generated by this package `Markdown Preview Enhanced: Create Toc`)
- [Markdown Preview Enhanced](#markdown-preview-enhanced)
- [Features](#features)
- [How it works](#how-it-works)
- [Usages](#usages)
- [Preview Context Menu](#preview-context-menu)
- [Extra](#extra)
- [For Developer](#for-developer)
- [Thanks](#thanks)
- [TODO](#todo)
---
## Features
- **2-side scroll sync**
- **[Code Chunks (beta)](./docs/code-chunk.md)**
- **[pandoc](./docs/advanced-export.md)**
- **[ebook](./docs/ebook.md)**
- **[Presentation Writer](https://rawgit.com/shd101wyy/markdown-preview-enhanced/master/docs/presentation-intro.html)**
- **[Extensible](#for-developer)**
- markdown preview with math typesetting support
You can choose [MathJax](https://github.com/mathjax/MathJax) or [KaTeX](https://github.com/Khan/KaTeX) to render math expressions
- export **PDF**, **PNG**, and **JPEG**
- export beautiful **HTML** (mobile device supported)
- customize Markdown Preview css
- [TOC](./docs/toc.md) generation **(beta)**
- Flowchart / Sequence diagram
- Task List *(Github Flavored)*
- Image Helper
- [Footnotes](https://github.com/shd101wyy/markdown-preview-enhanced/issues/35)
- [Front Matter](https://github.com/shd101wyy/markdown-preview-enhanced/issues/100)
- And many more...
## How it works
- [remarkable](https://github.com/jonschlinkert/remarkable) to convert markdown to html.
- [KaTeX](https://github.com/Khan/KaTeX) or [MathJax](https://github.com/mathjax/MathJax) to render math expressions. ([KaTeX Supported functions/symbols](https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX))
- expression within `$...$` will be rendered normally.
- expression within `$$...$$` will be rendered in displayMode.
- if you want to enable math highlighting, try [language-gfm-enhanced](https://atom.io/packages/language-gfm-enhanced) package.
- You can choose your math rendering method from [settings panel](#settings-panel).
**MathJax** supports more symbols, but it has slower rendering speed compared to **KaTeX**.
- 
- [mermaid](https://github.com/knsv/mermaid) to render flowchart and sequence diagram.
- code block within `{mermaid}` notation will be rendered by [mermaid](https://github.com/knsv/mermaid)
- check [mermaid doc](http://knsv.github.io/mermaid/#flowcharts-basic-syntax) for more information about how to create flowchart and sequence diagram
- 
- [PlantUML](http://plantuml.com/) to create multiple kinds of graph. (**Java** is required)
- You can install [Graphviz](http://www.graphviz.org/) (not required) to generate all diagram types.
- code block within `{puml}` or `{plantuml}` notation will be rendered by [PlantUML](http://plantuml.com/).
- [WaveDrom](http://wavedrom.com/) to create digital timing diagram.
- code block within `{wavedrom}` notation will be rendered by [wavedrom](https://github.com/drom/wavedrom).
- [Viz.js](https://github.com/mdaines/viz.js) to render [dot language](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) graph.
- code block within `{viz}` notation will be rendered by [Viz.js](https://github.com/mdaines/viz.js).
- add `engine:[engine_name]` in the first line of code block with `{viz}` to choose different render engine
- [reveal.js](https://github.com/hakimel/reveal.js) to render beautiful presentations.
- [Click here](https://rawgit.com/shd101wyy/markdown-preview-enhanced/master/docs/presentation-intro.html) to see the introduction.
## Usages
To use this package, press cmd + shift + p in atom editor first to toggle Command Palette . Then choose the commands below:
- Markdown Preview Enhanced: Toggle
- Toggle Markdown file preview with KaTeX support.
You can also use the keymap ctrl+shift+m to toggle preview. (To use keymap, you have to disable the default [markdown preview](https://atom.io/packages/markdown-preview) package, otherwise there would be keymap conflict)
- Markdown Preview Enhanced: Customize CSS
- Customize preview page css. You can edit styles inside `markdown-preview-enhanced-custom` section in `style.less` file.
- if you didn't see `markdown-preview-enhanced-custom` section in `style.less` file, you may need to run `Markdown Preview Enhanced: Customize CSS` command first.
- Markdown Preview Enhanced: Create Toc
- Generate TOC. [doc is here](./docs/toc.md).
or simply insert ` ` in editor (need preview toggled).
- Markdown Preview Enhanced: Toggle Scroll Sync
- Enable/Disable scroll sync for preview.
- Markdown Preview Enhanced: Toggle Break On Single Newline
- Enable/Disable breaking on single newline.
- Markdown Preview Enhanced: Insert New Slide
- Markdown Preview Enhanced: Insert Table
- Markdown Preview Enhanced: Insert Page Break
- Markdown Preview Enhanced: Config Mermaid
- edit `mermaid` init configuration.
- Markdown Preview Enhanced: Config Header Footer
- **PDF** export header and footer configuration.
- Markdown Preview Enhanced: Image Helper
- Image Helper supports image url quick insertion, image paste, and image upload powered by [imgur](http://imgur.com/) and [sm.ms](https://sm.ms/).
(if **imgur** is blocked by **the Great Firewall**, then you can choose **sm.ms** instead).
- Keymap ctrl+shift+i
- 
## Preview Context Menu
**Right click at preview to see the menu**
- Open in Browser
- Open HTML in browser
- **Export to Disk**
- Export **HTML**, **PDF**, **PNG**, **JPEG**, **ePub** etc files.
- **Pandoc Document Export**
- [doc](./docs/advanced-export.md)
## Extra
* **Code Chunks** [doc](./docs/code-chunk.md)
* **EBook**
More information about how to create ebook can be found [here](./docs/ebook.md).
* **Presentation Writer**
More information about how to create Presentation can be found [here](https://rawgit.com/shd101wyy/markdown-preview-enhanced/master/docs/presentation-intro.html).
* **Task List**
This package supports *Github Flavored* task list.
More information about how to create **task list** can be found [here](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
* **Smart Navigation**
You can quickly open another markdown file by clicking its link in preview.
* **Preview Auto Open**
Open preview pane automatically when you open a markdown file. You can disable this functionality from settings panel.
## For Developer
Manual installation instruction can be found [here](./docs/DEVELOPER.md).
It is also very easy to write your own extension, more information can be found [here](./docs/extension.md).
## Thanks
Thanks for everyone that supports this package!
## TODO
- [ ] fix bugs
- [ ] modify css to make preview look nice
- [x] ePub output
- [x] support more image upload methods other than imgur (as imgur is blocked in some countries)
- [x] image paste [#30](https://github.com/shd101wyy/markdown-preview-enhanced/issues/30)
- [ ] pdf book generation [#56](https://github.com/shd101wyy/markdown-preview-enhanced/issues/56)
- [x] header and footer for pdf [57](https://github.com/shd101wyy/markdown-preview-enhanced/issues/57)
Thanks for using and supporting this package ;)
> University of Illinois/NCSA Open Source License