GitHunt
HM

HMJiangGatech/markdown-preview-plus

Markdown Preview + Community Features

Markdown Preview Plus (MPP)

appveyor
travis
apm version
apm downloads
dependency status

Markdown Preview Plus (MPP) is a fork of Markdown
Preview
that provides a
real-time preview of markdown documents.

Should you have any problems while installing or using MPP please open
up a new
issue
.

MPP

Features

We also have a more detailed description of
features.

  • Quickly open a preview of any markdown with ctrl-shift-m
  • Math rendering with persistent macro support, toggled with
    ctrl-shift-x
  • Optionally use pandoc with citation support
  • Live reload while editing
  • On demand synchronization
  • And many more...

Installation

Long instructions can be found here. In short
steps:

  1. Search for and install markdown-preview-plus in Atom's Settings
    view.
  2. Search for and disable the built-in package markdown-preview.
  3. (Optional) Install and enable Pandoc.

Usage

Please see options for further details on configuring
MPP and math for more details on math rendering. For
basic usage:

  • Toggle Preview: ctrl-shift-m
  • Toggle Math Rendering: ctrl-shift-x

Contributing

See CONTRIBUTING.md.

Also of interest might be issues marked as "help wanted"

License

Markdown Preview Plus (MPP) is released under the MIT
license
.

Languages

TypeScript91.5%CSS4.9%JavaScript3.3%HTML0.4%
Other
Created June 28, 2018
Updated January 1, 2021