Each doc page has navigation that helps readers move around your help centre. Learn what each part does and how to control it.
📷 Image placeholder: a doc page with the sidebar, breadcrumbs, table of contents and feedback widget labelled.
The parts of a doc page
| Part | Where it appears | What it does |
|---|---|---|
| Sidebar | Left | Lists the categories and docs in the current knowledge base. |
| Breadcrumbs | Above the title | Shows the knowledge base and category the doc belongs to. |
| Table of contents | Right | Lists the headings in the doc and highlights the section being read. |
| Feedback widget | Bottom | Asks Was this helpful? and collects reader feedback. |
| Previous and next links | Bottom | Link to the docs before and after this one in the sidebar order. |
Control the sidebar
The sidebar shows your categories and docs in the order you set. To change it:
Order your categories
Set the order of your categories in the PinkDocs category settings.
Order your docs
Open each doc and set its Order in the Settings sidebar. Lower numbers appear first.
📷 Image placeholder: the Order field in the doc Settings sidebar.
Check the result
Open any doc on your site and check the sidebar order.
Build a useful table of contents
PinkDocs builds the table of contents from the headings in your doc. Follow these rules to keep it clear:
- Use H2 headings for main sections and H3 headings for sub-sections.
- Keep headings short and descriptive, such as Add a menu link.
- Don't skip levels. Use an H2 before any H3.
Turn page elements on or off
Go to PinkDocs → Settings and open the Doc page options to show or hide the table of contents, breadcrumbs, feedback widget and previous and next links.
📷 Image placeholder: the Doc page options in PinkDocs Settings.
Common questions
Check that the doc uses heading blocks rather than bold paragraphs, and that the table of contents is turned on in settings.
Change its status to Draft or Private. Only published docs appear in the sidebar.