Git Product home page Git Product logo

markdown-it-pandoc's Introduction

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.

Options Plugin dependency
bracketed_spans + attributes markdown-it-bracketed-spans
attributes markdown-it-attrs
fenced_divs + attributes markdown-it-container
definition lists markdown-it-deflist
footnotes markdown-it-footnote
implicit_figures markdown-it-implicit-figures
grid_tables markdown-it-gridtables
subscript markdown-it-sub
superscript markdown-it-sup
katex markdown-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');

markdown-it-pandoc's People

Contributors

crissov avatar ickc avatar mb21 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.