Documentation Guides

Table of Contents #

A table-of-content per documentation page is automatically generated with the rendered page. It is hidden on mobile, and only shown on tablets and desktop. This table of content is generated by parsing the titles in the documentation source page, excluding the main <h1> title of the page.

Consider the following page content:

# A main title

## Part title
### sub-title

## Another part

This will rendered as the following table of content:

- Part title
    - sub-title
- Another part

The table of content can be clicked to directly go to the desired section of the document, and is updated in real-time through scroll of the page.