• markdown-toc-cli
  • Installation
  • Usage
    • pre-commit Hook

markdown-toc-cli

Insert a table-of-contents into a Markdown file.

Heavily inspired from this project: https://github.com/hukkin/mdformat-toc

I'd recommend using that unless you don't want to run the built-in mdformat formatting. Then this tool might be suitable for a standalone version.

Installation

pip install markdown-toc-cli

Usage

Add a comment like this to the Markdown file:

<!-- markdown-toc-cli --prefix='- ' --indentation='  ' --minlevel=1 --maxlevel=6 -->

All arguments are optional, with the defaults values shown above (compatible with GitHub flavored markdown).

Then run the tool:

markdown-toc-cli README.md

pre-commit Hook

Example usage of this as a pre-commit hook:

- repo: https://github.com/noahp/markdown-toc-cli
  rev: 0.1.1
  hooks:
  - id: markdown-toc-cli