Have ideas to improve npm?Join in the discussion! »

    remarkable-plugin-heading-id
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    Remarkable plugin heading id

    Feature

    This is plugin for remarkable. This plugin will allow you to add id attribute to heading tags. (id attribute is needed for page-in-navigation-link)

    For Example,

    ## headings2
    
    paragraph
    

    above markdown will be parsed into

    <h2 id="headings2">headings2</h2>
    <p>paragraph</p>

    Usage

    yarn add remarkable-plugin-heading-id remarkable -D
    

    and

    import { Remarkable } from "remarkable";
    import { remarkablePluginHeadingId } from "remarkable-plugin-heading-id";
    
    const md = new Remarkable();
    
    md.use(remarkablePluginHeadingId, {
        // this option is for create id, optional option, default value is (level, content, idx) => `${content}`
        createId: (
        level: 1 | 2 | 3 | 4 | 5 | 6,
        content: string,
        idx: number
      ) => `some string`;
      // this option is for identify which headings should be added id, optional option, default value is ["h1", "h2", "h3", "h4", "h5", "h6"]
      targets?: typeof headings[number][];
    });
    
    md.render(html);

    LICENSE

    MIT

    Install

    npm i remarkable-plugin-heading-id

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    306 kB

    Total Files

    23

    Last publish

    Collaborators

    • avatar