md-toc 0.0.1

An utility that is able to generate a table of contents for a markdown file.

Automatically generate a table of contents for a markdown file to improve document readability.

The table of contents generated by this program is designed to work with markdown parsers such as the one used by GitHub and GitLab.

When used with the in-place option this script will write the table of contents at the first occurrency of a marker. The default marker is [](TOC) which will result as invisible when reading the parsed markdown file.

Titles up to three indentation levels (in HTML: h1, h2, h3) will be included in the table of contents.

As a final remark, it is possible to generate an ordered and an unordered table of contents. In both cases, each element of the toc is a clickable link to a paragraph in the page.

Video

Documentation

http://frnmst.github.io/md-toc

Conventions

• PEP.

• 4 space indentation.

Help

usage: md_toc [-h] [-v] {wtoc} ...

Markdown Table Of Contents

positional arguments:
  {wtoc}
    wtoc         write the table of contents

  optional arguments:
    -h, --help     show this help message and exit
    -v, --version  show program's version number and exit

  Return values: 0 OK, 1 Error, 2 Invalid command

License

Copyright (C) 2017 frnmst (Franco Masotti) <[e-mail]> <[e-mail]>

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