Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

atom-community/markdown-preview-plus

Repository files navigation

Project status

Atom is virtually dead, it's getting more broken each release, and since recently I can't publish new package versions. I have neither time nor patience to deal with that. I'm switching to VSCode and markdown-preview-enchanced.

As of May, 25th 2022, this project is officially unmaintained. Create an issue and ping @lierdakil if you want to and can take over.

Markdown Preview Plus (MPP)

CI 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. (Note: This is not the Chrome browser extension of the same name, which can be found here).

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.