Skip to content

Simple tool to create a TOC (table of contents) and compliant with GitHub Flavored Markdown (GFM).

License

Notifications You must be signed in to change notification settings

niquenen/gfm-toc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3897718 · Sep 24, 2024

History

48 Commits
Sep 17, 2024
Sep 14, 2024
Sep 24, 2024
Sep 14, 2024
Sep 17, 2024
Sep 17, 2024
Sep 14, 2024
Sep 17, 2024
Sep 17, 2024
Sep 17, 2024
Sep 17, 2024
Sep 24, 2024
Sep 14, 2024

Repository files navigation

gfm-toc

Simple tool to create a TOC (table of contents) and compliant with GitHub Flavored Markdown (GFM).

Install

Install with npm.

  1. Add registry in .npmrc config file.

    @niquenen:registry=https://npm.pkg.github.com
  2. Install the npm package.

    npm install --global @niquenen/gfm-toc
  3. Use gfm-toc.

    gfm-toc <path>

Contributing

Pull requests are always welcome. For bugs and feature requests, please create an issue.