diff --git a/README.md b/README.md index 123b9fc..c3044df 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,9 @@ after md-toc and similar tools were created: - [pre-commit](https://pre-commit.com/) [hook](https://docs.franco.net.eu.org/md-toc/pre_commit_hook.html) +And more! See the +[feature comparison table](https://docs.franco.net.eu.org/md-toc/features.html) + ## Examples You can use md-toc in your blog, documentation based on markdown, diff --git a/docs/features.rst b/docs/features.rst new file mode 100644 index 0000000..f2ca28e --- /dev/null +++ b/docs/features.rst @@ -0,0 +1,260 @@ +Features +======== + +=== =============== +Key Meaning +=== =============== +✓ implemented +/ partial support +✘ not implemented +? unknown +P feature planned +=== =============== + +.. note:: This feature table 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. + +.. list-table:: Feature comparison + :header-rows: 1 + + * - Feature + - md-toc + - `github-markdown-toc `_ + - `markdown-toc `_ + - `remark-toc `_ + - `markdown-it-table-of-contents `_ + - `gfm-toc `_ + - `md-toc-creator `_ + - `mdformat-toc `_ + - `git-toc `_ + * - Works offline + - ✓ + - ✘ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + * - Inplace & stdout + - ✓ + - ✓ + - ✓ + - ? + - ? + - ✓ + - ✓ + - ✘ + - ✘ + * - Indented & non-indented list + - ✓ + - ✘ + - ✘ + - ? + - ✘ + - ✘ + - ✓ + - ? + - ✘ + * - Ordered & unordered list + - ✓ + - ✘ + - ✘ + - ✓ + - ✓ + - ✘ + - ✘ + - ? + - ✘ + * - Anchor links & plain text list + - ✓ + - ✘ + - ✘ + - ? + - ? + - ✘ + - ✓ + - ✓ + - ✘ + * - Max header level in TOC + - ✓ + - ✘ + - ? + - ✓ + - ✓ + - ✘ + - ✘ + - ✓ + - ✘ + * - Min header level in TOC + - ✘ + - ✘ + - ✘ + - ✘ + - ✓ + - ✘ + - ✘ + - ✓ + - ✘ + * - Skip first n lines + - ✓ + - ✘ + - ? + - ? + - ✘ + - ✘ + - ✘ + - ✘ + - ✘ + * - Reads from stdin + - ✓ + - ✓ + - ✓ + - ? + - ? + - ✘ + - ? + - ✘ + - ✘ + * - List marker selection + - ✓ + - ✘ + - ✓ + - ? + - ? + - ✘ + - ? + - ? + - ✘ + * - Newline marker selection + - ✓ + - ✘ + - ? + - ? + - ? + - ? + - ? + - ? + - ✘ + * - Include headings regex pattern + - ✘ + - ✘ + - ? + - ✓ + - ✘ + - ✘ + - ✘ + - ✘ + - ✘ + * - Skip headings regex pattern + - ✘ + - ✘ + - ? + - ✓ + - ✘ + - ✘ + - ✘ + - ✘ + - ✘ + * - Skip headings before TOC marker + - ✘ + - ✓ + - ? + - ? + - ? + - ? + - ? + - ? + - ? + * - Non-markdown output + - ✘ [P] + - ✘ + - ✓ + - ? + - ✓ + - ✘ + - ✘ + - ? + - ✘ + * - Universal anchor links + - ✘ + - ? + - ✘ + - ✘ + - ✘ + - ✘ + - ✘ + - ✓ + - ✘ + * - Remote markdown files + - ✘ + - ✓ + - ✘ + - ✘ + - ✘ + - ✘ + - ✘ + - ✘ + - ✘ + * - Last TOC update string + - ✘ + - ✓ + - ? + - ? + - ? + - ? + - ? + - ? + - ? + * - Provides CLI + - ✓ + - ✓ + - ✓ + - ✘ + - ✘ + - ✓ + - ✓ + - ✘ + - ✓ + * - Provides API + - ✓ + - ✘ + - ✓ + - ? + - ✓ + - ? + - ? + - ✓ + - ? + * - Tries to follow markdown specs literally + - ✓ + - ? + - ? + - ? + - ? + - ✘ + - ✘ + - / + - ✘ + * - pre-commit hook + - ✓ + - ? + - ? + - ? + - ? + - ? + - ? + - ? + - ? + * - Active project + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✘ + - ✘ + - ✓ + - ✓ diff --git a/docs/index.rst b/docs/index.rst index a99b98d..fb5662e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,7 @@ md-toc documentation install api + features markdown_specification rules/index pre_commit_hook