⚠️starting from version 9 all the functions will only be accessible via the full module path. For example: md_toc.build_toc(...) will become md_toc.api.build_toc(...)⚠️

Features#

Feature tables and comparisons with other similar projects. Listed features correspond to the latest versions of these programs.

Key

Meaning

implemented

/

partial support

not implemented

?

unknown

P

feature planned

Note

These feature tables might not be up to date or accurate! Do your own research. If you find a mistake you are welcome to open an issue or pull request.

Inputs and outputs#

Feature

md-toc

github-markdown-toc

markdown-toc

remark-toc

markdown-it-table-of-contents

gfm-toc

md-toc-creator

mdformat-toc

git-toc

markdown-github-bear-toc

mdtoc

markdown-toc-cli

toc2md

github-markdown-toc.go

markdown-toc-generator

make-toc.sh

markdown-toc-bash

md_toc

Indented & non-indented list

?

?

?

?

?

?

?

?

?

?

?

Ordered & unordered list

?

?

?

?

?

?

?

?

?

?

Anchor links & plain text list

?

?

?

?

?

?

?

?

?

?

?

Reads from stdin

?

?

?

?

?

?

?

?

?

?

?

?

Inplace & stdout

?

?

?

?

?

?

?

?

?

?

?

Non-markdown output

P

?

?

?

?

?

?

?

?

?

?

?

List marker selection

?

?

?

?

?

?

?

?

?

?

?

?

?

Newline marker selection

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

Universal anchor links

?

?

?

?

?

?

?

?

?

?

Last TOC update string

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

Remove TOC marker after inserting TOC inplace

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

Detect differences between existing TOC in file and newly generated one

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

Filtering#

Feature

md-toc

github-markdown-toc

markdown-toc

remark-toc

markdown-it-table-of-contents

gfm-toc

md-toc-creator

mdformat-toc

git-toc

markdown-github-bear-toc

mdtoc

markdown-toc-cli

toc2md

github-markdown-toc.go

markdown-toc-generator

make-toc.sh

markdown-toc-bash

md_toc

Max header level in TOC

?

?

?

?

?

?

?

?

?

?

Min header level in TOC

?

?

?

?

?

?

?

?

?

Skip first n lines

?

?

?

?

?

?

?

?

?

?

?

Include headings regex pattern

?

?

?

?

?

?

?

?

?

?

Skip headings regex pattern

?

?

?

?

?

?

?

?

?

?

Skip headings based on a marker

P

?

?

?

?

?

?

?

?

?

Skip all headings before the TOC marker

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

Remote usage#

Feature

md-toc

github-markdown-toc

markdown-toc

remark-toc

markdown-it-table-of-contents

gfm-toc

md-toc-creator

mdformat-toc

git-toc

markdown-github-bear-toc

mdtoc

markdown-toc-cli

toc2md

github-markdown-toc.go

markdown-toc-generator

make-toc.sh

markdown-toc-bash

md_toc

Works offline

?

?

?

?

?

Remote markdown files

?

?

?

?

?

Other#

Feature

md-toc

github-markdown-toc

markdown-toc

remark-toc

markdown-it-table-of-contents

gfm-toc

md-toc-creator

mdformat-toc

git-toc

markdown-github-bear-toc

mdtoc

markdown-toc-cli

toc2md

github-markdown-toc.go

markdown-toc-generator

make-toc.sh

markdown-toc-bash

md_toc

Provides CLI

?

?

?

?

?

?

?

?

Provides API

?

?

?

?

?

?

?

?

?

?

?

?

?

Tries to follow markdown specs literally

?

?

?

?

/

?

?

?

?

?

?

?

?

?

pre-commit hook

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

Active project

?

?

?

?

?

?

?

?