Md-toc

From Free Software Directory
Jump to: navigation, search

Reviews: 0 ... further results.

Overview

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 generated by this program is designed to work with several markdown parsers such as the one used by GitHub and GitLab.

When used with the in-place option this script will write the table of contents at the first occurrency of a marker. The default marker is [](TOC) which will result as invisible when reading the parsed markdown file.

By default, titles up to three indentation levels (in HTML: h1, h2, h3) will be included in the table of contents.

As a final remark, it is possible to generate an ordered and an unordered table of contents. In both cases, each element of the toc is by default a clickable link to a paragraph in the page. It is also possible to generate non-linked version of the TOC.

Rules for generating the table of contents are determined by the selected markdown parser. md_toc aimes to be as conformant as possible in respect to each one of them.

Documentation

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





Details

Licensing

License

Verified by

Verified on

Notes




Leaders and contributors

Contact(s)Role


Resources and communication

AudienceResource typeURI
Python (Ref)https://pypi.org/project/md-toc


Software prerequisites

KindDescription
Required to usehttps://github.com/frnmst/fpyutils
Required to usePython 3

About this entry

This entry (in part or in whole) was last reviewed on 3 April 2018.


<headertabs />


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.












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.