Metadata-Version: 2.1
Name: md-toc
Version: 3.1.0
Summary: An utility that is able to generate a table of contents for a markdown file.
Home-page: https://github.com/frnmst/md-toc
Author: Franco Masotti
Author-email: franco.masotti@live.com
License: GPL
Keywords: markdown toc
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: Intended Audience :: End Users/Desktop
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5, <4
Requires-Dist: fpyutils (>=0.0.2)

Markdown Table Of Contents
==========================

|pypiver|    |license|    |pyver|    |downloads|    |gitter|    |dependentrepos|

.. |pypiver| image:: https://img.shields.io/pypi/v/md-toc.svg
               :alt: PyPI md-toc version

.. |license| image:: https://img.shields.io/pypi/l/md-toc.svg?color=blue
               :alt: PyPI - License
               :target: https://raw.githubusercontent.com/frnmst/md-toc/master/LICENSE.txt

.. |pyver| image:: https://img.shields.io/pypi/pyversions/md-toc.svg
             :alt: PyPI - Python Version

.. |downloads| image:: https://pepy.tech/badge/md-toc
                 :alt: Downloads
                 :target: https://pepy.tech/project/md-toc

.. |gitter| image:: https://badges.gitter.im/md-toc/community.svg
              :alt: Gitter
              :target: https://gitter.im/md-toc/community

.. |dependentrepos| image:: https://img.shields.io/librariesio/dependent-repos/pypi/md-toc.svg
                      :alt: Dependent repos (via libraries.io)

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

Video
-----

.. image:: https://asciinema.org/a/234434.png
     :target: https://asciinema.org/a/234434
     :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.

When used with the in-place option this script will write TOC at the first
occurrency of a marker. The default marker is ``[](TOC)``, which 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 any
wanted level.

md_toc makes it is possible to generate ordered or 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 non-linked 
version of the TOC. 

If the user wants it, there is the possibility to ignore space indentations
within the TOC.

Rules for generating the TOC are determined by the selected 
markdown parser. md-toc aimes to be as conformant as possible in respect to 
each one of them. This was possible by studying the available 
documentation and/or reverse engineering the source code.

Documentation
-------------

http://frnmst.github.io/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: http://frnmst.github.io/md-toc/markdown_specification.html

Helps
-----


::


    $ md_toc --help
    $ md_toc github --help
    $ md_toc redcarpet --help


License
-------

Copyright (C) 2017-2019 frnmst (Franco Masotti) <franco.masotti@live.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/>.



