mdtoc Documentation

Welcome !

Welcome to the documentation of the mdtoc project !

This website inventories all the documentation for all the Python files (*.py) of the project. There is one page per file. You can browse files now using the browser on the left.
This website contains the documentation for all the functions and classes of the mdtoc project.

Getting Started

Get the Project

First clone the git repository :

$ git clone https://github.com/Teskann/mdtoc

Then move to the project folder :

$ cd ./mdtoc

Install Modules

This project uses the following non-standard modules :

If you don't have them, you can install these packages running pip :

$ pip install

$ pip install marko

$ pip install mdtoc

$ pip install setuptools

Learn More

For more details, check out the mdtoc repository here : https://github.com/Teskann/mdtoc

About the Documentation