Nerfed Poet Melancholia

    This package has been deprecated

    Author message:

    Package has been moved to @robb_j/md-toc

    gen-md-toc

    0.1.0 • Public • Published

    Markdown Table of Contents Generator

    Quickly generate a table of contents from a markdown file and optionally insert it inline.

    Table of Contents

    Usage

    Installation

    # Install on a project as a dev dependancy
    npm i -D gen-md-toc

    Example use

    # Output a table of contents for a README.md in the current directory
    npx gen-md-toc
    
    # Insert a table of contents in the local README.md
    # -> Replaces inbetween <!-- toc-head --> and <!-- toc-tail -->
    npx gen-md-toc -i
    
    # Output a table of contents for a different file
    npx gen-md-toc -f CONTRIBUTING.md

    Full usage info

    Usage: gen-md-toc [options]
    
    A tool for generating a table of contents for readmes
    
    Options:
      -V, --version          output the version number
      -f --file [README.md]  specify where the readme file you want to use is (default: "README.md")
      -i --inline [false]    whether to edit the table of contents inline, it replaces for '<!-- toc-head -->' and <!-- toc-tail --> (default: false)
      -h, --help             output usage information
    

    Dependancies

    This module only has 2 dependancies, casex & commander, as of writing neither of which have any nested dependancies.

    API

    You can use this programmatically in node by importing the module, see cli.js for detailed usage.

    const { tableOfContents, headTag, tailTag } = require('gen-md-toc')
    
    // filename: string
    // inline: boolean
    tableOfContents(filename, inline)

    Keywords

    none

    Install

    npm i gen-md-toc

    DownloadsWeekly Downloads

    1

    Version

    0.1.0

    License

    ISC

    Unpacked Size

    6.18 kB

    Total Files

    7

    Last publish

    Collaborators

    • robb_j