README.md

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.