Difference between revisions of "Md-toc"

From Free Software Directory
Jump to: navigation, search
m (Fixed typo)
(Updated version.)
(13 intermediate revisions by 2 users not shown)
Line 26: Line 26:
 
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.
−
|Homepage URL=https://github.com/frnmst/md-toc
+
|Homepage URL=https://blog.franco.net.eu.org/software/#md-toc
−
|Is High Priority Project=No
+
|Version download=https://blog.franco.net.eu.org/software/md-toc-8.1.1/md-toc-8.1.1.tar.gz
−
|VCS checkout command=git clone https://github.com/frnmst/md-toc
 
−
|Computer languages=Python
 
−
|Documentation note=Documentation at: http://frnmst.github.io/md-toc
 
−
|Decommissioned or Obsolete=No
 
−
|Donate=https://www.buymeacoffee.com/frnmst
 
−
|Keywords=markdown, md, table-of-contents, toc
 
−
|Version identifier=7.0.1
 
−
|Version date=2020/03/26
 
−
|Version status=beta
 
−
|Version download=https://github.com/frnmst/md-toc/archive/7.0.1.tar.gz
 
−
|Version comment=Fixed asciinema link.
 
−
|Last review by=Frnmst
 
−
|Last review date=2020/04/05
 
−
|Submitted date=2018/01/27
 
−
|User level=intermediate
 
−
|Component programs=Python 3
 
−
|Accepts cryptocurrency donations=No
 
−
|Test entry=No
 
−
|Is GNU=No
 
 
}}
 
}}
 
{{Project license
 
{{Project license
 
|License=GPLv3orlater
 
|License=GPLv3orlater
−
|License copyright=Copyright (C) 2017-2020 frnmst (Franco Masotti) <franco.masotti@live.com>
+
|License copyright=Copyright (C) 2017-2022 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T 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 64: Line 45:
 
You should have received a copy of the GNU General Public License
 
You should have received a copy of the GNU General Public License
 
along with md-toc.  If not, see <http://www.gnu.org/licenses/>.
 
along with md-toc.  If not, see <http://www.gnu.org/licenses/>.
−
}}
+
|License verified by=agyaanapan
−
{{Person}}
+
|License verified date=2021-06-13
−
{{Resource
+
|License note=See also https://docs.franco.net.eu.org/md-toc/copyright_license.html for a list of all the licenses used.
−
|Resource audience=Python (Ref)
 
−
|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 83: Line 57:
 
|Use=text-creation
 
|Use=text-creation
 
|Works-with=text
 
|Works-with=text
 +
}}
 +
{{EntryGNU
 +
|Is GNU=No
 
}}
 
}}
 
{{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 116: Line 93:
 
|Prerequisite description=pipenv
 
|Prerequisite description=pipenv
 
}}
 
}}
−
{{Software prerequisite
+
{{Person}}
−
|Prerequisite kind=Required to build
+
{{Resource
−
|Prerequisite description=nose
+
|Resource audience=Python (Ref)
 +
|Resource URL=https://pypi.org/project/md-toc
 +
}}
 +
{{Resource
 +
|Resource audience=Users, Developers
 +
|Resource kind=Bug Tracking
 +
|Resource URL=https://software.franco.net.eu.org/frnmst/md-toc/issues
 +
}}
 +
{{Resource
 +
|Resource audience=Users, Developers
 +
|Resource kind=Bug Tracking
 +
|Resource URL=https://github.com/frnmst/md-toc/issues
 +
}}
 +
{{Resource
 +
|Resource audience=Users, Developers
 +
|Resource kind=Bug Tracking
 +
|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 audience=Documentation
 +
|Resource kind=Support
 +
|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
 
}}
 
}}
−
{{Software prerequisite
+
{{EntryDetails
−
|Prerequisite kind=Required to build
+
|Is High Priority Project=No
−
|Prerequisite description=nose-timer
+
|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.1.1
 +
|Version date=2022-01-27
 +
|Version status=beta
 +
|Version comment=Fixed issue #30: full support to cmark 0.30 (excluding previously existing bugs to fix in md-toc).
 +
|Last review by=Frnmst
 +
|Last review date=2022-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.1.1/md-toc-8.1.1.tar.gz.sig
 +
|OpenPGP public key=https://blog.franco.net.eu.org/pubkeys/pgp_pubkey_since_2019.txt
 +
|Test entry=No
 
}}
 
}}
 
{{Featured}}
 
{{Featured}}

Revision as of 14:00, 27 January 2022


[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/



Download

https://blog.franco.net.eu.org/software/md-toc-8.1.3/md-toc-8.1.3.tar.gz

version 8.1.3 (beta)
released on 20 April 2022



OpenPGP signature URL: https://blog.franco.net.eu.org/software/md-toc-8.1.3/md-toc-8.1.3.tar.gz.sig
OpenPGP public key: https://blog.franco.net.eu.org/pubkeys/pgp_pubkey_since_2019.txt

User level

Intermediate

https://www.buymeacoffee.com/frnmst

Accepts cryptocurrency donations.

VCS Checkout

Categories





Licensing

License

Verified by

Verified on

Notes

License

GPLv3orlater

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 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 20 April 2022.



Version comment

- Added bracket support detection in emphasis for cmark. - Speed and memory improvements.


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.

Retrieved from "https://directory.fsf.org/wiki?title=Md-toc&oldid=86645"