markdown-it-preview

This repo is a fork of the core markdown-preview package for Atom which replaces the Roaster Markdown parser with MarkdownIt.

MarkdownIt plugins can be added on a per-project basis using a config file in each project's root directory.

Demo project

Install

1. Search for and install markdown-it-preview in Atom's Settings view, or

$ apm install markdown-it-preview

2. Disable markdown-preview

Customize

The settings from the core package still apply. Additional options for markdown-it can be set there as well.

Plugins

Start a new project and add some MarkdownIt plugins. Note that the markdown-it package does not need to be installed in the new project.

$ mkdir my-project && cd $_
$ npm init -y
$ npm i -S markdown-it-emoji

Add the markdown-it-plugin.config.js file to let markdown-it-preview know which plugins need to be loaded

module.exports = {
  plugins: [
    'markdown-it-emoji'
  ],
}

Write some Markdown

$ echo ':tada: :fireworks:' > test.md
$ atom test.md

Toggle Preview with CTRL-SHIFT-M

License

MIT