2.1.0 • Published 3 years ago

markdown-it-pandoc v2.1.0

Weekly downloads
5
License
MIT
Repository
github
Last release
3 years ago

markdown-it-pandoc

Package bundling a few markdown-it plugins to approximate pandoc flavoured markdown.

For a demo, you can try PanWriter.

Dependencies

This package requires a lot of peer dependencies, depending on which extensions you enable. For up-to-date information, it is probably best to take a quick look at the source.

OptionsPlugin dependency
bracketed_spans + attributesmarkdown-it-bracketed-spans
attributesmarkdown-it-attrs
fenced_divs + attributesmarkdown-it-container
definition listsmarkdown-it-deflist
footnotesmarkdown-it-footnote
implicit_figuresmarkdown-it-implicit-figures
grid_tablesmarkdown-it-gridtables
subscriptmarkdown-it-sub
superscriptmarkdown-it-sup
task_listsmarkdown-it-task-lists
katexmarkdown-it-texmath, katex

Usage

var md = require('markdown-it')();
require('markdown-it-pandoc')(md);
md.render('my markdown string');

There is an optional second argument to enable/disable markdown-it-pandoc extensions. For example:

var md = require('markdown-it')({ html: true });
require('markdown-it-pandoc')(md, { implicit_figures: false });
md.render('my markdown string');

Or using import syntax:

import markdownIt from 'markdown-it'
import markdownItPandoc from 'markdown-it-pandoc'

const md = markdownItPandoc(
  markdownIt({ html: true }),
  { implicit_figures: false }
);
md.render('my markdown string');