Difference between revisions of "Md-toc"

From Free Software Directory
Jump to: navigation, search
(Updated to new version)
(Updated info for new release.)
Line 25: Line 25:
respect to each one of them. This was possible by studying the available  
respect to each one of them. This was possible by studying the available  
documentations and by reverse engineering the source codes.
documentations and by reverse engineering the source codes.
|Screenshot 1=https://asciinema.org/a/240852.png
|Homepage URL=https://github.com/frnmst/md-toc
|Homepage URL=https://github.com/frnmst/md-toc
|Is High Priority Project=No
|Is High Priority Project=No
Line 31: Line 32:
|Documentation note=Documentation at: http://frnmst.github.io/md-toc
|Documentation note=Documentation at: http://frnmst.github.io/md-toc
|Decommissioned or Obsolete=No
|Decommissioned or Obsolete=No
|IRC help=https://gitter.im/md-toc/community
|IRC general=https://gitter.im/md-toc/community
|IRC development=https://gitter.im/md-toc/community
|Keywords=markdown, md, table-of-contents, toc
|Keywords=markdown, md, table-of-contents, toc
|Version identifier=4.0.0
|Version identifier=5.0.0
|Version date=2019/04/04
|Version date=2019/04/14
|Version status=alpha
|Version status=alpha
|Version download=https://github.com/frnmst/md-toc/archive/4.0.0.tar.gz
|Version download=https://github.com/frnmst/md-toc/archive/5.0.0.tar.gz
|Version comment=Bug fixes. Improved documentation. Separated build_toc from the build_multiple_tocs function.
|Version comment=Added new coherence list checks and its CLI option. Atomic file writes thanks to fpyutils.
|Last review by=Frnmst
|Last review by=Frnmst
|Last review date=2019/04/04
|Last review date=2019/04/14
|Submitted date=2018/01/27
|Submitted date=2018/01/27
|User level=intermediate
|User level=intermediate

Revision as of 17:45, 14 April 2019



Automatically generate and add an accurate table of contents to markdown files.


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


  • 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 at: https://docs.franco.net.eu.org/md-toc/

Related Projects



Verified by

Verified on


Verified by


Verified on

13 June 2021


See also https://docs.franco.net.eu.org/md-toc/copyright_license.html for a list of all the licenses used.

Leaders and contributors


Resources and communication

AudienceResource typeURI
Users, DevelopersBug Trackinghttps://framagit.org/frnmst/md-toc/-/issues
Users, DevelopersChangeloghttps://blog.franco.net.eu.org/software/CHANGELOG-md-toc.html
Users, DevelopersBug Trackinghttps://software.franco.net.eu.org/frnmst/md-toc/issues
Users, DevelopersBug Trackinghttps://codeberg.org/frnmst/md-toc/issues
Users, DevelopersBug Trackinghttps://github.com/frnmst/md-toc/issues
Python (Ref)https://pypi.org/project/md-toc

Software prerequisites

Required to buildpython3-build
Required to buildflake8-docstrings
Required to buildsphinx-copybutton
Required to buildsphinx-book-theme
Weak prerequisitepyfakefs
Required to buildvenv
Required to usehttps://blog.franco.net.eu.org/software/#fpyutils
Required to buildFlake8
Required to useSetuptools
Required to buildSphinx
Required to usePython 3

This entry (in part or in whole) was last reviewed on 8 August 2023.

Version comment

Release 8.2.0 - Add the new `--diff` option - Add more comparisons in the feature tables (see documentation) - Closed old issue for inactivity


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

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.