Newly Purchased Memories

    markdown-it-chain

    1.3.0 • Public • Published

    markdown-it-chain

    A chaining API like webpack-chain but for markdown-it.

    NPM version

    Install

    Yarn

    yarn add -dev markdown-it-chain

    npm

    npm install --save-dev markdown-it-chain

    Getting Started

    // Require the markdown-it-chain module. This module exports a single
    // constructor function for creating a configuration API.
    const Config = require('markdown-it-chain')
     
    // Instantiate the configuration with a new API
    const config = new Config()
     
    // Make configuration changes using the chain API.
    // Every API call tracks a change to the stored configuration.
    config
      // Interact with 'options' in new MarkdownIt
      // Ref: https://markdown-it.github.io/markdown-it/#MarkdownIt.new
      .options
        .html(true) // equal to .set('html', true)
        .linkify(true)
        .end()
     
      // Interact with 'plugins'
      .plugin('toc')
        // The first parameter is the plugin module, which may be a function
        // while the second parameter is an array of parameters accepted by the plugin.
        .use(require('markdown-it-table-of-contents'), [{
          includeLevel: [2, 3]
        }])
        // Move up one level, like .end() in jQuery.
        .end()
     
      .plugin('anchor')
        .use(require('markdown-it-anchor'), [{
          permalink: true,
          permalinkBefore: true,
          permalinkSymbol: '$'
        }])
        // Apply this plugin before toc.
        .before('toc')
     
    // Create a markdown-it instance using the above configuration
    const md = config.toMd()
    md.render('[[TOC]] \n # h1 \n ## h2 \n ## h3 ')

    Worth Reading

    In order to ensure the consistency of the chained API world, webpack-it-chain is developed directly on the basis of webpack-chain and ensures that the usage is completely consistent.

    Here are some things worth reading that come from webpack-chain:

    Author

    markdown-it-chain © ULIVZ, Released under the MIT License.
    Authored and maintained by ULIVZ with help from contributors (list).

    github.com/ulivz · GitHub @ULIVZ · Twitter @_ulivz

    Install

    npm i markdown-it-chain

    DownloadsWeekly Downloads

    101,865

    Version

    1.3.0

    License

    MIT

    Unpacked Size

    8.48 kB

    Total Files

    7

    Last publish

    Collaborators

    • ulivz