Difference between revisions of "Md-toc"
(Update to version 9.0.0.) |
|||
(40 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{Entry | {{Entry | ||
|Name=md-toc | |Name=md-toc | ||
− | |Short description=Automatically generate | + | |Short description=Automatically generate and add an accurate table of contents to markdown files. |
− | |Full description= | + | |Full description===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 [https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/ interactive TOC button] at the top-left of readme files. This system works for markdown and others | ||
+ | * GitLab added an [https://docs.gitlab.com/ee/user/markdown.html#table-of-contents extension] called Table of contents to its Gitlab Flavored Mardown | ||
− | + | ==Features== | |
− | + | ||
− | + | * works offline | |
− | + | * edits file in place using a TOC marker 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 | |
− | + | * 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 | |
− | |Version download=https:// | + | * handles multiple files at once |
− | + | * selection of newline string | |
− | + | * check if there is difference between existing TOC in file and newly generated one | |
− | + | * selection of list marker | |
− | + | * supports GitHub, GitLab, Commonmark, Redcarpet and others | |
− | + | * [https://pre-commit.com/ pre-commit] md-toc [https://docs.franco.net.eu.org/md-toc/pre_commit_hook.html hook] | |
− | + | ||
− | + | And more! See the [https://docs.franco.net.eu.org/md-toc/features.html feature comparison table] | |
− | + | |Homepage URL=https://blog.franco.net.eu.org/software/#md-toc | |
− | + | |Version download=https://blog.franco.net.eu.org/software/md-toc-9.0.0/md-toc-9.0.0.tar.gz | |
}} | }} | ||
{{Project license | {{Project license | ||
|License=GPLv3orlater | |License=GPLv3orlater | ||
− | |License copyright=Copyright (C) 2017- | + | |License copyright=Copyright (C) 2017-2024 Franco Masotti (see /README.md) |
md-toc is free software: you can redistribute it and/or modify | md-toc is free software: you can redistribute it and/or modify | ||
Line 48: | Line 50: | ||
You should have received a copy of the GNU General Public License | You should have received a copy of the GNU General Public License | ||
along with md-toc. If not, see <http://www.gnu.org/licenses/>. | along with md-toc. If not, see <http://www.gnu.org/licenses/>. | ||
− | + | |License verified by=agyaanapan | |
− | + | |License verified date=2021-06-13 | |
− | + | |License note=See also https://docs.franco.net.eu.org/md-toc/meta.html#copyright-and-license for a list of all the licenses used. | |
− | | | ||
− | | | ||
}} | }} | ||
{{Software category | {{Software category | ||
Line 58: | Line 58: | ||
|Interface=command-line, console, text | |Interface=command-line, console, text | ||
|Programming-language=python | |Programming-language=python | ||
− | |Runs-on=GNU/Linux | + | |Runs-on=Windows, OS X, GNU/Linux |
|Text-creation=documentation-tool | |Text-creation=documentation-tool | ||
|Use=text-creation | |Use=text-creation | ||
|Works-with=text | |Works-with=text | ||
+ | }} | ||
+ | {{EntryGNU | ||
+ | |Is GNU=No | ||
}} | }} | ||
{{Software prerequisite | {{Software prerequisite | ||
|Prerequisite kind=Required to use | |Prerequisite kind=Required to use | ||
− | |Prerequisite description=https:// | + | |Prerequisite description=https://blog.franco.net.eu.org/software/#fpyutils |
}} | }} | ||
{{Software prerequisite | {{Software prerequisite | ||
|Prerequisite kind=Required to use | |Prerequisite kind=Required to use | ||
|Prerequisite description=Python 3 | |Prerequisite description=Python 3 | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to use | ||
+ | |Prerequisite description=Setuptools | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to build | ||
+ | |Prerequisite description=Flake8 | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to build | ||
+ | |Prerequisite description=flake8-docstrings | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to build | ||
+ | |Prerequisite description=Sphinx | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to build | ||
+ | |Prerequisite description=sphinx-book-theme | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to build | ||
+ | |Prerequisite description=sphinx-copybutton | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to build | ||
+ | |Prerequisite description=venv | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Required to build | ||
+ | |Prerequisite description=python3-build | ||
+ | }} | ||
+ | {{Software prerequisite | ||
+ | |Prerequisite kind=Weak prerequisite | ||
+ | |Prerequisite description=pyfakefs | ||
+ | }} | ||
+ | {{Person}} | ||
+ | {{Resource | ||
+ | |Resource audience=Python (Ref) | ||
+ | |Resource kind=General | ||
+ | |Resource URL=https://pypi.org/project/md-toc | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Users, Developers | ||
+ | |Resource kind=Bug Tracking | ||
+ | |Resource URL=https://software.franco.net.eu.org/frnmst/md-toc/issues | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Users, Developers | ||
+ | |Resource kind=Bug Tracking | ||
+ | |Resource URL=https://github.com/frnmst/md-toc/issues | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Users, Developers | ||
+ | |Resource kind=Bug Tracking | ||
+ | |Resource URL=https://codeberg.org/frnmst/md-toc/issues | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Users, Developers | ||
+ | |Resource kind=Bug Tracking | ||
+ | |Resource URL=https://framagit.org/frnmst/md-toc/-/issues | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Documentation | ||
+ | |Resource kind=Support | ||
+ | |Resource URL=https://docs.franco.net.eu.org/md-toc/ | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Users, Developers | ||
+ | |Resource kind=Changelog | ||
+ | |Resource URL=https://blog.franco.net.eu.org/software/CHANGELOG-md-toc.html | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Video | ||
+ | |Resource kind=Support | ||
+ | |Resource URL=https://redirect.invidious.io/watch?v=guyVdPNmC0A | ||
+ | }} | ||
+ | {{Resource | ||
+ | |Resource audience=Video | ||
+ | |Resource kind=Support | ||
+ | |Resource URL=https://redirect.invidious.io/watch?v=6QaW4qv7y1o | ||
+ | }} | ||
+ | {{EntryDetails | ||
+ | |Is High Priority Project=No | ||
+ | |VCS checkout command=git clone https://software.franco.net.eu.org/frnmst/md-toc.git | ||
+ | |Computer languages=Python | ||
+ | |Documentation note=Documentation at: https://docs.franco.net.eu.org/md-toc/ | ||
+ | |Decommissioned or Obsolete=No | ||
+ | |Donate=https://www.buymeacoffee.com/frnmst | ||
+ | |Microblog=https://social.franco.net.eu.org/@frnmst | ||
+ | |Related projects=fpyutils | ||
+ | |Keywords=markdown, md, table-of-contents, toc | ||
+ | |Version identifier=9.0.0 | ||
+ | |Version date=2024-04-10 | ||
+ | |Version status=stable | ||
+ | |Version comment=Release 9.0.0 - API change: cleaner module imports. For example: `md_toc.build_toc` becomes `md_toc.api.build_toc` - Fix variables: all of them have snake case when possible - Cleanup constants file - Important bug fixes for edge cases inputs - Add `md_toc.api.anchor_link_punctuation_filter` function - Project structure improvements | ||
+ | |Last review by=Frnmst | ||
+ | |Last review date=2024-04-10 | ||
+ | |User level=intermediate | ||
+ | |Component programs=Python 3 | ||
+ | |Accepts cryptocurrency donations=Yes | ||
+ | |OpenPGP signature=https://blog.franco.net.eu.org/software/md-toc-9.0.0/md-toc-9.0.0.tar.gz.sig | ||
+ | |OpenPGP public key=https://blog.franco.net.eu.org/pubkeys/pgp_pubkey_since_2019.txt | ||
+ | |Test entry=No | ||
}} | }} | ||
{{Featured}} | {{Featured}} |
Latest revision as of 18:28, 10 April 2024
md-toc
https://blog.franco.net.eu.org/software/#md-toc
Automatically generate and add an accurate table of contents to markdown files.
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 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
- 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
- selection of list marker
- supports GitHub, GitLab, Commonmark, Redcarpet and others
- pre-commit md-toc hook
And more! See the feature comparison table
Documentation
Documentation at: https://docs.franco.net.eu.org/md-toc/
Download
https://blog.franco.net.eu.org/software/md-toc-9.0.0/md-toc-9.0.0.tar.gz
version 9.0.0
(stable)
released on 10 April 2024
OpenPGP signature URL: https://blog.franco.net.eu.org/software/md-toc-9.0.0/md-toc-9.0.0.tar.gz.sig
OpenPGP public key: https://blog.franco.net.eu.org/pubkeys/pgp_pubkey_since_2019.txt
User level
IntermediateMicroblog

Donate link
https://www.buymeacoffee.com/frnmstAccepts cryptocurrency donations.
VCS Checkout
Categories
Related Projects
Licensing
License
Verified by
Verified on
Notes
License
Verified by
agyaanapan
Verified on
13 June 2021
Notes
See also https://docs.franco.net.eu.org/md-toc/meta.html#copyright-and-license for a list of all the licenses used.
Leaders and contributors
Contact(s) | Role |
---|---|
Resources and communication
Audience | Resource type | URI |
---|---|---|
Video | Support | https://redirect.invidious.io/watch?v=6QaW4qv7y1o |
Users, Developers | Bug Tracking | https://framagit.org/frnmst/md-toc/-/issues |
Users, Developers | Changelog | https://blog.franco.net.eu.org/software/CHANGELOG-md-toc.html |
Users, Developers | Bug Tracking | https://software.franco.net.eu.org/frnmst/md-toc/issues |
Python (Ref) | General | https://pypi.org/project/md-toc |
Users, Developers | Bug Tracking | https://codeberg.org/frnmst/md-toc/issues |
Documentation | Support | https://docs.franco.net.eu.org/md-toc/ |
Video | Support | https://redirect.invidious.io/watch?v=guyVdPNmC0A |
Users, Developers | Bug Tracking | https://github.com/frnmst/md-toc/issues |
Software prerequisites
Kind | Description |
---|---|
Required to build | python3-build |
Required to build | flake8-docstrings |
Required to build | sphinx-copybutton |
Required to build | sphinx-book-theme |
Weak prerequisite | pyfakefs |
Required to build | venv |
Required to use | https://blog.franco.net.eu.org/software/#fpyutils |
Required to build | Flake8 |
Required to use | Setuptools |
Required to build | Sphinx |
Required to use | Python 3 |
This entry (in part or in whole) was last reviewed on 10 April 2024.
Version comment
Release 9.0.0 - API change: cleaner module imports. For example: `md_toc.build_toc` becomes `md_toc.api.build_toc` - Fix variables: all of them have snake case when possible - Cleanup constants file - Important bug fixes for edge cases inputs - Add `md_toc.api.anchor_link_punctuation_filter` function - Project structure improvements
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.
The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.