markdown-it-all

markdown-it-all

An integration of markdown-it and plugins.

Install

$ yarn add markdown-it-all

Usage

Simple

import MarkdownIt, { markdownItAll, markdownItCustom } from '../index'

const content = '# markdown-it rulezz!\n'
let md = new MarkdownIt()
let html = md.render(content)
console.log(html)
// '<h1>markdown-it rulezz!</h1>\n'

md = markdownItAll()
html = md.render(content)
console.log(html)
// '<h1 id="markdown-it-rulezz" data-source-line="1"><a class="anchor" href="#markdown-it-rulezz"><span class="octicon octicon-link"></span></a>markdown-it rulezz!</h1>\n'

md = markdownItCustom({sourceMap: true})
html = md.render(content)
console.log(html)
// '<h1 data-source-line="1">markdown-it rulezz!</h1>\n'

Interface

function markdownItCustom (options: ICustomPlugins): MarkdownIt
interface ICustomPlugins {
    abbreviation?: true,
    customContainer?: string[],
    definitionList?: true,
    emoji?: true,
    footnote?: true,
    githubToc?: GithubTocOptions,
    insert?: true,
    latex?: true,
    mark?: true,
    mermaid?: true,
    sourceMap?: true,
    subscript?: true,
    superscript?: true,
    taskList?: true,
}

Plugins

Support List

• abbreviation
• custom container
• definition list
• emoji
• footnote
• github toc
• insert
• latex
• mark
• mermaid
• source map
• subscript
• superscript
• task list

License

MIT