Markdown Table Of Contents
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
<!--TOC-->, which, being
an HTML comment, will result invisible after the markdown file has
By default titles up to three indentation levels (in HTML:
h3) will be included in the TOC but the user can decide to keep all
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.
Please read carefully the Markdown specification section of the documentation to learn how this program parsers markdown files and builds a correct output.
md-toc has a public API. This means for example that you can you easily build a TOC within another Python program. The easiest way to build one for a markdown file is:
>>> import md_toc >>> f = open('foo.md') >>> print(f.read(), end='') # this ## is ## a ### foo #### booo ### foo ## file ## bye # bye >>> print(md_toc.build_toc('foo.md'), end='') - [this](#this) - [is](#is) - [a](#a) - [foo](#foo) - [foo](#foo-1) - [file](#file) - [bye](#bye) - [bye](#bye-1)
$ md_toc --help $ md_toc github --help $ md_toc redcarpet --help
Copyright (C) 2017-2019 frnmst (Franco Masotti) <email@example.com>
md-toc is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
md-toc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with md-toc. If not, see <http://www.gnu.org/licenses/>.