Automatically generate a compliant table of contents for a markdown file to improve document readability
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.
When used with the in-place option this script will write the TOC at the first occurrency of a marker. The default marker is ````, which, being an HTML comment, will result invisible after the markdown file has been translated.
By default titles up to three indentation levels (in HTML: ``h1``, ``h2``, ``h3``) will be included in the TOC but the user can decide to keep all possible levels.
md_toc makes it is possible to generate ordered and unordered TOCs. In both cases each element of the TOC is by default a link to a paragraph in the web page. It is also possible to generate a non-linked version of the TOC.
If the user wants it, there is the possibility to ignore space indentations within the TOC and to skip an initial number of lines from the markdown file.
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.
DocumentationDocumentation at: http://frnmst.github.io/md-toc
released on 20 January 2021
OpenPGP signature URL: https://frnmst.gitlab.io/software/md-toc-7.1.0.tar.gz.sig
OpenPGP public key: https://frnmst.gitlab.io/pubkeys/pgp_pubkey_2020.txt
git clone https://github.com/frnmst/md-toc
Leaders and contributors
Resources and communication
|Required to use||https://github.com/frnmst/fpyutils|
|Required to build||pipenv|
|Required to use||Python 3|
|Required to build||Read the Docs Sphinx Theme|
|Required to build||Flake8|
|Required to build||flake8-docstrings|
|Required to build||Sphinx|
|Required to use||Setuptools|
This entry (in part or in whole) was last reviewed on 20 January 2021.
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.