# markdown-preview-plus

**Repository Path**: coxhin/markdown-preview-plus

## Basic Information

- **Project Name**: markdown-preview-plus
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-26
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown Preview Plus (MPP)

[![appveyor](https://img.shields.io/appveyor/ci/lierdakil/markdown-preview-plus/master.svg?label=appveyor)](https://ci.appveyor.com/project/lierdakil/markdown-preview-plus/branch/master)
[![travis](https://img.shields.io/travis/atom-community/markdown-preview-plus/master.svg?label=travis)](https://travis-ci.org/atom-community/markdown-preview-plus)
![apm version](https://img.shields.io/apm/v/markdown-preview-plus.svg)
![apm
downloads](https://img.shields.io/apm/dm/markdown-preview-plus.svg)
[![dependency status](https://david-dm.org/atom-community/markdown-preview-plus/status.svg)](https://david-dm.org/atom-community/markdown-preview-plus)

Markdown Preview Plus (MPP) is a fork of [Markdown
Preview](https://github.com/atom/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](https://github.com/atom-community/markdown-preview-plus/issues).

![MPP](https://raw.githubusercontent.com/atom-community/markdown-preview-plus/master/imgs/mpp-full-res-invert.png)

## Features

We also have a more detailed description of
[features](https://github.com/atom-community/markdown-preview-plus/blob/master/docs/features.md).

-   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](https://github.com/atom-community/markdown-preview-plus/blob/master/docs/installation.md). 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](https://pandoc.org).

## Usage

Please see [options](https://github.com/atom-community/markdown-preview-plus/blob/master/docs/options.md) for further details on configuring
MPP and [math](https://github.com/atom-community/markdown-preview-plus/blob/master/docs/math.md) for more details on math rendering. For
basic usage:

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

## Contributing

See [CONTRIBUTING.md](https://github.com/atom-community/markdown-preview-plus/blob/master/CONTRIBUTING.md).

Also of interest might be [issues marked as "help wanted"](https://github.com/atom-community/markdown-preview-plus/labels/help%20wanted)

## License

Markdown Preview Plus (MPP) is released under the [MIT
license](https://github.com/atom-community/markdown-preview-plus/blob/master/LICENSE.md).