Explain how to make toc-trees in Markdown

This commit is contained in:
Griatch 2020-04-10 11:57:50 +02:00
parent ea7f7e012b
commit 3ad404cddb

View file

@ -205,13 +205,17 @@ This will be automatically translated to the matching github link so the reader
> This is not currently working. (WIP) > This is not currently working. (WIP)
## Making indices ## Making toc-tree indices
To make a document tree (what Sphinx refers to as a "Toc Tree"), make a list of document urls like this: To make a Table-of-Contents listing (what Sphinx refers to as a "Toc Tree"), one
must make new heading named either `Contents` or `Index`, followed by a bullet-list of
links:
``` ```
* [Title1](doc1.md) # Index
* [Title2](doc2.md)
- [Title1](doc1)
- [Title2](doc2)
``` ```