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 |
|||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Indented & non-indented list |
✘ |
✘ |
? |
✘ |
✘ |
✓ |
? |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
|
Ordered & unordered list |
✓ |
✘ |
✘ |
✓ |
✓ |
✘ |
✘ |
? |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
Anchor links & plain text list |
✓ |
✘ |
✘ |
? |
? |
✘ |
✓ |
✓ |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
Reads from stdin |
✓ |
✓ |
? |
? |
✘ |
? |
✘ |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
|
Inplace & stdout |
✓ |
✓ |
✓ |
? |
? |
✓ |
✓ |
✘ |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
Non-markdown output |
✘ |
✓ |
? |
✓ |
✘ |
✘ |
? |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
|
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 |
|||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
|
Skip all headings before the TOC marker |
✘ |
✓ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
Remote usage#
Feature |
md-toc |
|||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Works offline |
✓ |
✘ |
✓ |
✓ |
✓ |
✓ |
✓ |
✓ |
✓ |
✓ |
✓ |
✓ |
? |
✘ |
? |
? |
? |
? |
Remote markdown files |
✘ |
✓ |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
✘ |
? |
✓ |
? |
? |
? |
? |
Other#
Feature |
md-toc |
|||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Provides CLI |
✓ |
✓ |
✓ |
✘ |
✘ |
✓ |
✓ |
✘ |
✓ |
? |
? |
? |
? |
✓ |
? |
? |
? |
? |
Provides API |
✓ |
✘ |
✓ |
? |
✓ |
? |
? |
✓ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
Tries to follow markdown specs literally |
✓ |
? |
? |
? |
? |
✘ |
✘ |
/ |
✘ |
? |
? |
? |
? |
? |
? |
? |
? |
? |
pre-commit hook |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
? |
|
Active project |
✓ |
✓ |
✓ |
✓ |
✓ |
✘ |
✘ |
✓ |
✓ |
? |
? |
? |
? |
✓ |
? |
? |
? |
? |