Developer Interface

Main Interface

Examples for the most relevant api functions can be viewed in the test file. md_toc’s API uses type hints instead of assertions to check input and output types.

Important

If you are a developer and you need a quick way to generate a TOC, the function you may want to use is build_toc

Exceptions