Browse Source

Preparing for new release.

master
Franco Masotti 2 months ago
parent
commit
0d8e4ead40
Signed by: frnmst
GPG Key ID: 24116ED85666780A
  1. 2
      Pipfile
  2. 50
      README.md
  3. 4
      docs/conf.py
  4. 2
      packages/aur/PKGBUILD
  5. 2
      setup.py

2
Pipfile

@ -1,7 +1,7 @@
#
# Pipfile
#
# Copyright (C) 2017-2021 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
# Copyright (C) 2017-2022 Franco Masotti (franco \D\o\T masotti {-A-T-} tutanota \D\o\T com)
#
# This file is part of md-toc.
#

50
README.md

@ -45,34 +45,34 @@ 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]{.title-ref}. See:
<https://docs.gitlab.com/ee/user/markdown.html#table-of-contents>
- 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]{.title-ref}. 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)
- 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

4
docs/conf.py

@ -65,9 +65,9 @@ author = 'Franco Masotti'
# built documents.
#
# The short X.Y version.
version = '8.1.3'
version = '8.1.4'
# The full version, including alpha/beta/rc tags.
release = '8.1.3'
release = '8.1.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

2
packages/aur/PKGBUILD

@ -1,7 +1,7 @@
# Maintainer: Franco Masotti <franco dot masotti at tutanota dot com>
# Contributor: Franco Masotti <franco dot masotti at tutanota dot com>
pkgname=python-md_toc
pkgver=8.1.3
pkgver=8.1.4
pkgrel=1
pkgdesc="Automatically generate a compliant table of contents for a markdown file to improve document readability"
arch=('any')

2
setup.py

@ -27,7 +27,7 @@ with open('README.md', 'r', encoding='utf-8') as f:
setup(
name='md_toc',
version='8.1.3',
version='8.1.4',
packages=find_packages(exclude=['*tests*']),
license='GPLv3+',
description='A utility that is able to generate a table of contents for a markdown file.',

Loading…
Cancel
Save