-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Continue fixing issue #36: add feature comparsion table
- Loading branch information
Showing
3 changed files
with
264 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <https://github.com/ekalinin/github-markdown-toc>`_ | ||
| - `markdown-toc <https://github.com/jonschlinkert/markdown-toc>`_ | ||
| - `remark-toc <https://github.com/remarkjs/remark-toc>`_ | ||
| - `markdown-it-table-of-contents <https://github.com/cmaas/markdown-it-table-of-contents>`_ | ||
| - `gfm-toc <https://github.com/waynerv/github-markdown-toc>`_ | ||
| - `md-toc-creator <https://github.com/mcb2003/md-toc-creator>`_ | ||
| - `mdformat-toc <https://github.com/hukkin/mdformat-toc>`_ | ||
| - `git-toc <https://github.com/PrzemekWirkus/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 | ||
| - ✓ | ||
| - ✓ | ||
| - ✓ | ||
| - ✓ | ||
| - ✓ | ||
| - ✘ | ||
| - ✘ | ||
| - ✓ | ||
| - ✓ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ md-toc documentation | |
|
|
||
| install | ||
| api | ||
| features | ||
| markdown_specification | ||
| rules/index | ||
| pre_commit_hook | ||
|
|
||