Md-toc

[edit]

• Overview
• Details
• About this entry

md-toc

https://github.com/frnmst/md-toc
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.

Documentation

Documentation at: http://frnmst.github.io/md-toc

Download

https://frnmst.gitlab.io/software/md-toc-7.0.3.tar.gz

version 7.0.3 (beta)
released on 24 June 2020

OpenPGP signature URL: https://frnmst.gitlab.io/software/md-toc-7.0.3.tar.gz.sig
OpenPGP public key: https://frnmst.gitlab.io/pubkeys/pgp_pubkey_2020.txt

User level

Intermediate

Donate link

https://www.buymeacoffee.com/frnmst

VCS Checkout

git clone https://github.com/frnmst/md-toc

Categories

• Documentation-tool:documentation-word-processing
• Interface:command-line
• Interface:console
• Interface:text
• Programming-language:python
• Runs-on:GNU/Linux
• Text-creation:documentation-tool
• Use:text-creation
• Works-with:text

Licensing

License

Verified by

Verified on

Notes

License

GPLv3orlater

Leaders and contributors

Contact(s)	Role

Resources and communication

Audience	Resource type	URI
Python (Ref)		https://pypi.org/project/md-toc
Everyone	General	https://gitter.im/md-toc/community

Software prerequisites

Kind	Description
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	nose
Required to build	flake8-docstrings
Required to build	nose-timer
Required to build	Sphinx
Required to use	Setuptools

This entry (in part or in whole) was last reviewed on 25 June 2020.

Entry

Property "Submitted by" (as page type) with input value "{{{Submitted by}}}" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.

"Python (Ref)" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.

"Everyone" is not in the list (General, Help, Bug Tracking, Support, Developer) of allowed values for the "Resource audience" property.