Difference between revisions of "Md-toc"

From Free Software Directory
Jump to: navigation, search
(updated to new release)
Line 2: Line 2:
 
|Name=md-toc
 
|Name=md-toc
 
|Short description=Automatically generate a compliant table of contents for a markdown file to improve document readability
 
|Short description=Automatically generate a compliant table of contents for a markdown file to improve document readability
|Full description=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.
+
|Full description=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 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.
+
When used with the in-place option this script will write TOC at the first occurrency of a marker. The default marker is [](TOC), which 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 table of contents.
+
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 any wanted level.
  
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.
+
md_toc makes it is possible to generate ordered or 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 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.
+
If the user wants it, there is the possibility to ignore space indentations within the TOC.
 +
 
 +
Rules for generating the TOC are determined by the selected markdown parser. md-toc aimes to be as conformant as possible in respect to each one of them. This was possible by studying the available documentation and/or reverse engineering the source code.
 
|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 18: Line 20:
 
|Decommissioned or Obsolete=No
 
|Decommissioned or Obsolete=No
 
|Keywords=markdown, md, table-of-contents, toc
 
|Keywords=markdown, md, table-of-contents, toc
|Version identifier=3.0.0
+
|Version identifier=3.1.0
|Version date=2019/03/18
+
|Version date=2019/03/29
 
|Version status=alpha
 
|Version status=alpha
|Version download=https://github.com/frnmst/md-toc/archive/3.0.0.tar.gz
+
|Version download=https://github.com/frnmst/md-toc/archive/3.1.0.tar.gz
|Version comment=New options. API change. Bugfixes.
+
|Version comment=Fixed code fence detection for github. Other fixes.
 
|Last review by=Frnmst
 
|Last review by=Frnmst
|Last review date=2019/03/19
+
|Last review date=2019/03/29
 
|Submitted date=2018/01/27
 
|Submitted date=2018/01/27
 
|User level=intermediate
 
|User level=intermediate

Revision as of 09:24, 29 March 2019


[edit]

md-toc

https://blog.franco.net.eu.org/software/#md-toc
Automatically generate a compliant table of contents for a markdown file to improve document readability

Description

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

Features

  • works offline
  • edits file in place using a TOC marker or output to standard output
  • selection of indentation level
  • 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
  • selection of list marker
  • supports GitHub, GitLab, Commonmark, Redcarpet and others
  • pre-commit hook

Documentation

Documentation at: https://docs.franco.net.eu.org/md-toc/





Licensing

License

Verified by

Verified on

Notes

Verified by

agyaanapan

Verified on

13 June 2021

Notes

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




Leaders and contributors

Contact(s)Role


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
DocumentationSupporthttps://docs.franco.net.eu.org/md-toc/
Users, DevelopersBug Trackinghttps://github.com/frnmst/md-toc/issues
Python (Ref)https://pypi.org/project/md-toc


Software prerequisites

KindDescription
Required to buildflake8-docstrings
Weak prerequisitepyfakefs
Required to buildpipenv
Required to buildsphinx-tabs
Required to usehttps://blog.franco.net.eu.org/software/#fpyutils
Required to buildFlake8
Required to useSetuptools
Required to buildRead the Docs Sphinx Theme
Required to buildSphinx
Required to usePython 3

This entry (in part or in whole) was last reviewed on 17 June 2022.



Version comment

- Improved readme according to issue #36. - Improved TOC marker detection and TOC substitution in place.


Entry










"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.