markdown-toclify is a Python command line script that adds a Table of Contents with internal section-links to Markdown documents.

• Usage
  • Optional arguments
• Examples
  • Input file
  • Simple output file
  • Output file with back-to-top links and vertical space

Requires:

• Python 2.7.x or 3.x
• argparse

[back to top]

The usage is quite simple, you just need to provide a Markdown-formatted input file and the modified Markdown contents will be printed to the standard output screen.

./markdown-toclify.py input.md

[back to top]

positional arguments:
  input.md              path to the Markdown input file

optional arguments:
  -h, --help            show this help message and exit
  -o output.md, --output output.md
                        path to the Markdown output file
  -b, --back_to_top     add [back to top] links.
  -g, --github          use Github-compatible link styles
  -s pixels, --spacer pixels
                        add horizontal space (in pixels) after the table of contents
  -n, --nolink          create the table of contents without internal links
  -v, --version         show program's version number and exit

#Examples [back to top]

[back to top]

[back to top]

Command:

./markdown-toclify.py input.md -o output.md

[back to top]

Command:

./markdown-toclify.py input.md -o output.md -b -s 100