Control the Previous and Next navigation buttons on project pages.
The navigation option also supports page-level configuration using front matter.
| Option | Type | Description |
|---|---|---|
| nextButton | PageLink object | Controls the next page button. |
| previousButton | PageLink object | Controls the previous page button. |
| actions | PageAction object | Controls the actions that appear on the page. |
| Option | Type | Description |
|---|---|---|
| hide | boolean | Hides the navigation link button. Default: false. |
| text | string | Specifies the text that appears above the navigation buttons. Default: Next page or Previous page respectively. |
| Option | Type | Description |
|---|---|---|
| label | string | Specifies the text that appears on the button. Default: the text of the first heading of the target page. |
| page | string | Path to a Markdown page in the project, or an URL. |
| Option | Type | Description |
|---|---|---|
| hide | boolean | Hides the page actions. Default: false. |
items | [string] | Lists the items that appear on the page and defines their order. The project hides items that you omit from the list. Allowed values:
The first item in the list is the default action. Default: |
You can customize the labels and descriptions for these actions using translation keys in your translations.yaml file. The translation keys for customizing page actions start with the page.actions. prefix.
For a full list of available keys, see Predefined translation keys.
The following example changes text labels of the navigation buttons to Next chapter and Previous chapter respectively. This configuration applies to all pages in the project.
navigation:
nextButton:
text: "Next chapter"
previousButton:
text: "Previous chapter"
The following example hides the navigation buttons on all pages of the project.
navigation:
nextButton:
hide: true
previousButton:
hide: true
The following example creates a custom reading flow. Instead of following the order of pages in the sidebar, navigation buttons direct the user to a page in a different section of the project.
---
navigation:
nextButton:
page: ../advanced-topics.md
text: "Next chapter"
label: Advanced concepts
previousButton:
page: ./docs/basics.md
text: "Previous chapter"
label: About basics
---
The following example disables the page actions on all pages of the project.
navigation:
actions:
hide: true
The following example includes only the copy and view actions, which hides the AI-related (ChatGPT, Claude) and MCP actions.
navigation:
actions:
items:
- copy
- view
- Front matter configuration options - Configure navigation button options on individual pages using front matter for granular control
- Configuration options - Explore other project configuration options for comprehensive documentation and platform customization