This commit is contained in:
Franco Masotti 2022-05-07 19:07:36 +02:00
parent e5b6a8b57a
commit b826b25f26
Signed by: frnmst
GPG Key ID: 24116ED85666780A
2 changed files with 1 additions and 240 deletions

View File

@ -15,7 +15,7 @@ to improve document readability.
## Video
[![image](https://asciinema.org/a/452384.png){.align-center}](https://asciinema.org/a/452384)
[![image](https://asciinema.org/a/452384.png)](https://asciinema.org/a/452384)
## Description

View File

@ -1,239 +0,0 @@
Markdown Table Of Contents
==========================
|pypiver| |debian| |nix| |downloads| |dependentrepos| |pre-commit| |buymeacoffee|
.. |pypiver| image:: https://img.shields.io/pypi/v/md-toc.svg
:alt: PyPI md-toc version
:target: https://pypi.org/project/md-toc/
.. |debian| image:: https://repology.org/badge/version-for-repo/debian_12/md-toc.svg
:alt: Debian 12 package
:target: https://repology.org/project/md-toc/versions
.. |nix| image:: https://repology.org/badge/version-for-repo/nix_unstable/python:md-toc.svg
:alt: nixpkgs unstable package
:target: https://repology.org/project/python:md-toc/versions
.. |downloads| image:: https://pepy.tech/badge/md-toc
:alt: Downloads
:target: https://pepy.tech/project/md-toc
.. |dependentrepos| image:: https://img.shields.io/librariesio/dependent-repos/pypi/md-toc.svg
:alt: Dependent repos (via libraries.io)
:target: https://libraries.io/pypi/md-toc/dependents
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:alt: pre-commit
:target: https://github.com/pre-commit/pre-commit
.. |buymeacoffee| image:: assets/buy_me_a_coffee.svg
:alt: Buy me a coffee
:target: https://buymeacoff.ee/frnmst
Automatically generate a compliant table of contents for a markdown file to
improve document readability.
Video
-----
.. image:: https://asciinema.org/a/452384.png
:target: https://asciinema.org/a/452384
:align: center
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 on the readme files of repositories which
works for markdown and other systems.
See:
https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/
- GitLab added an extension called ``Table of contents`` to
its `Gitlab Flavored Mardown`. See:
https://docs.gitlab.com/ee/user/markdown.html#table-of-contents
Features
--------
- works offline
- edits file in place using a TOC marker (default ``<!--TOC-->``) 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 <https://pre-commit.com/>`_ `hook <https://docs.franco.net.eu.org/md-toc/pre_commit_hook.html>`_
Examples
--------
You can use md-toc in your blog, documentation based on markdown, etc...
I use it in `my Jekyll-based blog <https://blog.franco.net.eu.org/>`_ along
with its `pre-commit hook <https://software.franco.net.eu.org/frnmst/blog/src/branch/master/.pre-commit-config.yaml>`_.
I also use it in most repositories where markdown README files are present.
Most markdown renderers do not provide a way to automatically generate a TOC so
md-toc is useful for this purpose.
A very common use case is this:
::
$ cat foo.md
# Table of contents
<!--TOC-->
# this
## is
## a
### foo
#### booo
### foo
## file
## bye
# bye
$ md_toc --in-place github --header-levels 6 foo.md # or: md_toc -p github -l6 foo.md
$ cat foo.md
# Table of contents
<!--TOC-->
- [Table of contents](#table-of-contents)
- [this](#this)
- [is](#is)
- [a](#a)
- [foo](#foo)
- [booo](#booo)
- [foo](#foo-1)
- [file](#file)
- [bye](#bye)
- [bye](#bye-1)
<!--TOC-->
# this
## is
## a
### foo
#### booo
### foo
## file
## bye
# bye
API examples
------------
md-toc has a `public API`_. This means for example that you can you easily
build a TOC within another Python program. The easiest way to build one
for a markdown file is:
::
>>> import md_toc
>>> f = open('foo.md')
>>> print(f.read(), end='')
# this
## is
## a
### foo
#### booo
### foo
## file
## bye
# bye
>>> print(md_toc.build_toc('foo.md'), end='')
- [this](#this)
- [is](#is)
- [a](#a)
- [foo](#foo)
- [foo](#foo-1)
- [file](#file)
- [bye](#bye)
- [bye](#bye-1)
.. _public API: https://docs.franco.net.eu.org/md-toc/api.html
Documentation
-------------
https://docs.franco.net.eu.org/md-toc/
Please read carefully the `Markdown specification`_ section of the documentation
to learn how this program parsers markdown files and builds a correct output.
.. _Markdown specification: https://docs.franco.net.eu.org/md-toc/markdown_specification.html
CLI Helps
---------
::
$ md_toc --help
$ md_toc cmark --help
$ md_toc commonmarker --help
$ md_toc github --help
$ md_toc gitlab --help
$ md_toc goldmark --help
$ md_toc redcarpet --help
License
-------
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
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
md-toc is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with md-toc. If not, see <http://www.gnu.org/licenses/>.
Changelog and trusted source
----------------------------
You can check the authenticity of new releases using my public key.
Changelogs, instructions, sources and keys can be found at `blog.franco.net.eu.org/software <https://blog.franco.net.eu.org/software/>`_.
Crypto donations
----------------
- Bitcoin: bc1qnkflazapw3hjupawj0lm39dh9xt88s7zal5mwu
- Monero: 84KHWDTd9hbPyGwikk33Qp5GW7o7zRwPb8kJ6u93zs4sNMpDSnM5ZTWVnUp2cudRYNT6rNqctnMQ9NbUewbj7MzCBUcrQEY
- Dogecoin: DMB5h2GhHiTNW7EcmDnqkYpKs6Da2wK3zP
- Vertcoin: vtc1qd8n3jvkd2vwrr6cpejkd9wavp4ld6xfu9hkhh0