Markdown Table Of Contents

Automatically generate and add an accurate table of contents to markdown files.

• Markdown Table Of Contents
  • Video
  • Description
  • Features
  • Examples
  • API examples
  • Documentation
  • CLI Helps
  • Extras
    • HTML output
  • License
  • Changelog and trusted source
  • Support this project

Video

Description

The table of contents (a.k.a: TOC) generated by this program is designed to work with several markdown parsers such as the ones used by GitHub and GitLab.

Rules for generating the TOC are determined by the selected markdown parser. md-toc aimes infact to be as conformant as possible in respect to each one of them. This was possible by studying the available documentations and by reverse engineering the source codes.

GitHub and GitLab have introduced their version of the markdown TOC after md-toc and similar tools were created:

• in March 2021 GitHub added an interactive TOC button at the top-left of readme files. This system works for markdown and others
• GitLab added an extension called Table of contents to its Gitlab Flavored Mardown

Features

• works offline
• edits file in place using a TOC marker (default <!--TOC-->) or output to standard output
• maximum heading level selection (1 to 6)
• list indentation based on heading, which can optionally be disabled
• outputs an ordered or unordered TOC list with list marker selection
• creates anchor links to markdown headings by default or a plain list as alternative
• checks if heading level is coherent: this avoid creating an erroneous TOC. This feature can be disabled if needed
• skip any number lines before generating the TOC
• can read content from standard input
• handles multiple files at once
• selection of newline string
• check if there is difference between existing TOC in file and newly generated one
• supports GitHub, GitLab, Commonmark, Redcarpet and others
• pre-commit md-toc hook

And more! See the feature comparison table

Examples

You can use md-toc in your blog, documentation based on markdown, GitHub pages, markdown files in Nextcloud, etc...

I use it in my Jekyll-based blog along with its pre-commit hook. I also use it in most repositories where README.md files are present.

Most markdown renderers do not provide a way to automatically generate a TOC so md-toc is useful for this purpose.

A very common use case is this:

$ cat foo.md

# Table of contents

<!--TOC-->

# this
## is
## a
### foo
#### booo
### foo
## file

## bye

# bye

$ md_toc --in-place github --header-levels 6 foo.md        # or: md_toc -p github -l6 foo.md
$ cat foo.md

# Table of contents

<!--TOC-->

- [Table of contents](#table-of-contents)
- [this](#this)
  - [is](#is)
  - [a](#a)
    - [foo](#foo)
      - [booo](#booo)
    - [foo](#foo-1)
  - [file](#file)
  - [bye](#bye)
- [bye](#bye-1)

<!--TOC-->

# this
## is
## a
### foo
#### booo
### foo
## file

## bye

# bye

API examples

md-toc has a public API. This means for example that you can you easily build a TOC within another Python program. The easiest way to build one for a markdown file is:

>>> import md_toc
>>> f = open('foo.md')
>>> print(f.read(), end='')
# this
## is
## a
### foo
#### booo
### foo
## file

## bye

# bye
>>> print(md_toc.build_toc('foo.md'), end='')
- [this](#this)
  - [is](#is)
  - [a](#a)
    - [foo](#foo)
    - [foo](#foo-1)
  - [file](#file)
  - [bye](#bye)
- [bye](#bye-1)

You can also write the TOC in place:

>>> import md_toc
>>> f = open('foo.md')
>>> print(f.read(), end='')
# Table of contents

<!--TOC-->

# this
## is
## a
### foo
#### booo
### foo
## file

Test

## bye

# bye
>>> toc = md_toc.build_toc('foo.md')
>>> md_toc.write_string_on_file_between_markers('foo.md', toc, '<!--TOC-->')
>>> f = open('foo.md')
>>> print(f.read(), end='')
# Table of contents

<!--TOC-->

- [Table of contents](#table-of-contents)
- [this](#this)
  - [is](#is)
  - [a](#a)
    - [foo](#foo)
    - [foo](#foo-1)
  - [file](#file)
  - [bye](#bye)
- [bye](#bye-1)

<!--TOC-->

# this
## is
## a
### foo
#### booo
### foo
## file

Test

## bye

# bye

Documentation

https://docs.franco.net.eu.org/md-toc/

Please read the Markdown specification section of the documentation to learn how this program parsers markdown files and builds a correct output.

CLI Helps

$ md_toc --help
$ md_toc cmark --help
$ md_toc commonmarker --help
$ md_toc github --help
$ md_toc gitlab --help
$ md_toc goldmark --help
$ md_toc redcarpet --help

Extras

HTML output

If you use Pandoc you can generate an HTML output starting from a markdown file. You can do something like:

pandoc --from=commonmark --to=html -o a.html README.md

License

Copyright (C) 2017-2023 Franco Masotti Franco Masotti

md-toc is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

md-toc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with md-toc. If not, see http://www.gnu.org/licenses/.

Changelog and trusted source

You can check the authenticity of new releases using my public key.

Changelogs, instructions, sources and keys can be found at blog.franco.net.eu.org/software/#md-toc.

Support this project

• Buy Me a Coffee
• Bitcoin: bc1qnkflazapw3hjupawj0lm39dh9xt88s7zal5mwu
• Monero: 84KHWDTd9hbPyGwikk33Qp5GW7o7zRwPb8kJ6u93zs4sNMpDSnM5ZTWVnUp2cudRYNT6rNqctnMQ9NbUewbj7MzCBUcrQEY
• Dogecoin: DMB5h2GhHiTNW7EcmDnqkYpKs6Da2wK3zP
• Vertcoin: vtc1qd8n3jvkd2vwrr6cpejkd9wavp4ld6xfu9hkhh0