Difference between revisions of "Md-toc"

From Free Software Directory
Jump to: navigation, search
(Updated URLs)
(Fixed FSD wiki variables. Added more references.)
 
(One intermediate revision by the same user not shown)
Line 27: Line 27:
 
documentations and by reverse engineering the source codes.
 
documentations and by reverse engineering the source codes.
 
|Homepage URL=https://blog.franco.net.eu.org/software/#md-toc
 
|Homepage URL=https://blog.franco.net.eu.org/software/#md-toc
|Version download=https://blog.franco.net.eu.org/software/md-toc-8.0.0/md-toc-8.0.0.tar.gz
+
|Version download=https://blog.franco.net.eu.org/software/md-toc-8.0.1/md-toc-8.0.1.tar.gz
|Is High Priority Project=No
 
|VCS checkout command=git clone https://software.franco.net.eu.org/frnmst/md-toc.git
 
|Computer languages=Python
 
|Documentation note=Documentation at: https://docs.franco.net.eu.org/md-toc/
 
|Decommissioned or Obsolete=No
 
|Donate=https://www.buymeacoffee.com/frnmst
 
|Keywords=markdown, md, table-of-contents, toc
 
|Version identifier=8.0.0
 
|Version date=2021/05/28
 
|Version status=beta
 
|Version comment=More fixes for the emphasis removal. Fixed parsers CLI. Improved documentation and tests.
 
|Last review by=Frnmst
 
|Last review date=2021/07/30
 
|Submitted date=2018/01/27
 
|User level=intermediate
 
|Component programs=Python 3
 
|Accepts cryptocurrency donations=Yes
 
|OpenPGP signature=https://blog.franco.net.eu.org/software/md-toc-8.0.0/md-toc-8.0.0.tar.gz.sig
 
|OpenPGP public key=https://blog.franco.net.eu.org/pubkeys/pgp_pubkey_since_2019.txt
 
|Test entry=No
 
 
}}
 
}}
 
{{Project license
 
{{Project license
 
|License=GPLv3orlater
 
|License=GPLv3orlater
|License copyright=Copyright (C) 2017-2021 frnmst (Franco Masotti) <franco.masotti@live.com>
+
|License copyright=Copyright (C) 2017-2021 frnmst (Franco Masotti) <franco.masotti@tutanota.com>
  
 
md-toc is free software: you can redistribute it and/or modify
 
md-toc is free software: you can redistribute it and/or modify
Line 67: Line 47:
 
|License verified by=agyaanapan
 
|License verified by=agyaanapan
 
|License verified date=2021-06-13
 
|License verified date=2021-06-13
 +
|License note=See also https://docs.franco.net.eu.org/md-toc/copyright_license.html for a list of all the licenses used.
 
}}
 
}}
 
{{Software category
 
{{Software category
Line 82: Line 63:
 
{{Software prerequisite
 
{{Software prerequisite
 
|Prerequisite kind=Required to use
 
|Prerequisite kind=Required to use
|Prerequisite description=https://github.com/frnmst/fpyutils
+
|Prerequisite description=https://blog.franco.net.eu.org/software/#fpyutils
 
}}
 
}}
 
{{Software prerequisite
 
{{Software prerequisite
Line 131: Line 112:
 
|Resource kind=Bug Tracking
 
|Resource kind=Bug Tracking
 
|Resource URL=https://codeberg.org/frnmst/md-toc/issues
 
|Resource URL=https://codeberg.org/frnmst/md-toc/issues
 +
}}
 +
{{Resource
 +
|Resource audience=Users, Developers
 +
|Resource kind=Bug Tracking
 +
|Resource URL=https://framagit.org/frnmst/md-toc/-/issues
 
}}
 
}}
 
{{Resource
 
{{Resource
Line 136: Line 122:
 
|Resource kind=Support
 
|Resource kind=Support
 
|Resource URL=https://docs.franco.net.eu.org/md-toc/
 
|Resource URL=https://docs.franco.net.eu.org/md-toc/
 +
}}
 +
{{Resource
 +
|Resource audience=Users, Developers
 +
|Resource kind=Changelog
 +
|Resource URL=https://blog.franco.net.eu.org/software/CHANGELOG-md-toc.html
 
}}
 
}}
 
{{EntryDetails
 
{{EntryDetails
 
|Is High Priority Project=No
 
|Is High Priority Project=No
 +
|VCS checkout command=git clone https://software.franco.net.eu.org/frnmst/md-toc.git
 +
|Computer languages=Python
 +
|Documentation note=Documentation at: https://docs.franco.net.eu.org/md-toc/
 
|Decommissioned or Obsolete=No
 
|Decommissioned or Obsolete=No
 +
|Donate=https://www.buymeacoffee.com/frnmst
 +
|Keywords=markdown, md, table-of-contents, toc
 +
|Version identifier=8.0.1
 +
|Version date=2021-08-20
 +
|Version status=beta
 +
|Version comment=Fixed cmark code. Other minor fixes.
 +
|Last review by=Frnmst
 +
|Last review date=2021-08-23
 +
|User level=intermediate
 +
|Component programs=Python 3
 
|Accepts cryptocurrency donations=Yes
 
|Accepts cryptocurrency donations=Yes
 +
|OpenPGP signature=https://blog.franco.net.eu.org/software/md-toc-8.0.1/md-toc-8.0.1.tar.gz.sig
 +
|OpenPGP public key=https://blog.franco.net.eu.org/pubkeys/pgp_pubkey_since_2019.txt
 
|Test entry=No
 
|Test entry=No
 
}}
 
}}
 
{{Featured}}
 
{{Featured}}

Latest revision as of 10:58, 23 August 2021


[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

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: 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
Required to buildpipenv
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 23 August 2021.



Version comment

Fixed cmark code. Other minor fixes.


Entry




























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


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


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


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


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


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


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







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. "{{{Submitted date}}}" contains an extrinsic dash or other characters that are invalid for a date interpretation.











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.