Difference between revisions of "Md-toc"

From Free Software Directory
Jump to: navigation, search
(Updated info for new release.)
(Updated to new release.)
 
(2 intermediate revisions by the same user not shown)
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 (a.k.a: TOC) generated by this program is designed to  
+
|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.
 
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 TOC at the first
+
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 will  
+
occurrency of a marker. The default marker is ``<!--TOC-->``, which, being
result invisible after the markdown file has been translated.
+
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``,  
+
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
 
``h3``) will be included in the TOC but the user can decide to keep all
 
possible levels.
 
possible levels.
Line 15: Line 16:
 
md_toc makes it is possible to generate ordered and unordered TOCs.
 
md_toc makes it is possible to generate ordered and unordered TOCs.
 
In both cases each element of the TOC is by default a
 
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  
+
link to a paragraph in the web page. It is also possible to generate
a non-linked version of the TOC.  
+
a non-linked version of the TOC.
  
 
If the user wants it, there is the possibility to ignore space indentations
 
If the user wants it, there is the possibility to ignore space indentations
within the TOC.
+
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  
+
Rules for generating the TOC are determined by the selected
markdown parser. md-toc aimes infact to be as conformant as possible in  
+
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  
+
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 32: 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=5.0.0
+
|Version identifier=6.0.0
|Version date=2019/04/14
+
|Version date=2019/06/12
 
|Version status=alpha
 
|Version status=alpha
|Version download=https://github.com/frnmst/md-toc/archive/5.0.0.tar.gz
+
|Version download=https://github.com/frnmst/md-toc/archive/5.0.1.tar.gz
|Version comment=Added new coherence list checks and its CLI option. Atomic file writes thanks to fpyutils.
+
|Version comment=Added skip lines option. Fixed indentation spaces issue. Other fixes.
 
|Last review by=Frnmst
 
|Last review by=Frnmst
|Last review date=2019/04/14
+
|Last review date=2019/06/12
 
|Submitted date=2018/01/27
 
|Submitted date=2018/01/27
 
|User level=intermediate
 
|User level=intermediate
Line 71: Line 68:
 
|Resource audience=Python (Ref)
 
|Resource audience=Python (Ref)
 
|Resource URL=https://pypi.org/project/md-toc
 
|Resource URL=https://pypi.org/project/md-toc
 +
}}
 +
{{Resource
 +
|Resource audience=Everyone
 +
|Resource kind=General
 +
|Resource URL=https://gitter.im/md-toc/community
 
}}
 
}}
 
{{Software category
 
{{Software category
Line 100: Line 102:
 
|Prerequisite kind=Required to build
 
|Prerequisite kind=Required to build
 
|Prerequisite description=Sphinx
 
|Prerequisite description=Sphinx
 +
}}
 +
{{Software prerequisite
 +
|Prerequisite kind=Required to use
 +
|Prerequisite description=Setuptools
 +
}}
 +
{{Software prerequisite
 +
|Prerequisite kind=Required to build
 +
|Prerequisite description=Alabaster
 
}}
 
}}
 
{{Featured}}
 
{{Featured}}

Latest revision as of 11:04, 12 June 2019

[edit]

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





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
EveryoneGeneralhttps://gitter.im/md-toc/community


Software prerequisites

KindDescription
Required to usehttps://github.com/frnmst/fpyutils
Required to buildAlabaster
Required to usePython 3
Required to buildFlake8
Required to buildflake8-docstrings
Required to buildSphinx
Required to useSetuptools

This entry (in part or in whole) was last reviewed on 12 June 2019.



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.






















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.