{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"navigation","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["navigation"]}]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Control the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Previous"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next"]}," navigation buttons on project pages."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["navigation"]}," option also supports page-level configuration using front matter."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":1},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["nextButton"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#pagelink-object"},"children":["PageLink object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls the next page button."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["previousButton"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#pagelink-object"},"children":["PageLink object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls the previous page button."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["actions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#pageaction-object"},"children":["PageAction object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls the actions that appear on the page."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pagelink-object","__idx":2},"children":["PageLink object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the navigation link button."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["text"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the text that appears above the navigation buttons."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Next page"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Previous page"]}," respectively."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"options-that-apply-to-front-matter-only","__idx":3},"children":["Options that apply to front matter only"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the text that appears on the button."," ","Default: the text of the first heading of the target page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path to a Markdown page in the project, or an URL."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pageaction-object","__idx":4},"children":["PageAction object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the page actions."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["items"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["[string]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists the items that appear on the page and defines their order."," ","The project hides items that you omit from the list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Allowed values:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["copy"]},": copy the page content as Markdown to the clipboard."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["view"]},": view the page content as Markdown in a new tab."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chatgpt"]},": ask ChatGPT about this page."," ","Supported only on public pages."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claude"]},": ask Claude about this page."," ","Supported only on public pages."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs-mcp-cursor"]},": connect to MCP server via Cursor."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs-mcp-vscode"]},": connect to MCP server via VS Code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs-mcp-claude"]},": connect to MCP server via Claude."," ","Opens claude.ai with the server name and URL filled in."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The first item in the list is the default action."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["copy"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["view"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chatgpt"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claude"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs-mcp-cursor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs-mcp-vscode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["docs-mcp-claude"]}," in this order."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"customize-page-action-labels","__idx":5},"children":["Customize page action labels"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can customize the labels and descriptions for these actions using translation keys in your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["translations.yaml"]}," file."," ","The translation keys for customizing page actions start with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.actions."]}," prefix."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a full list of available keys, see ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/content/localization/translation-keys"},"children":["Predefined translation keys"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":6},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"change-navigation-buttons-text-globally","__idx":7},"children":["Change navigation buttons text globally"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example changes text labels of the navigation buttons to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next chapter"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Previous chapter"]}," respectively."," ","This configuration applies to all pages in the project."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"navigation:\n  nextButton:\n    text: \"Next chapter\"\n  previousButton:\n    text: \"Previous chapter\"\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"hide-navigation-links-globally","__idx":8},"children":["Hide navigation links globally"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example hides the navigation buttons on all pages of the project."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"navigation:\n  nextButton:\n    hide: true\n  previousButton:\n    hide: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"customize-navigation-buttons-in-the-front-matter","__idx":9},"children":["Customize navigation buttons in the front matter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"---\nnavigation:\n  nextButton:\n    page: ../advanced-topics.md\n    text: \"Next chapter\"\n    label: Advanced concepts\n  previousButton:\n    page: ./docs/basics.md\n    text: \"Previous chapter\"\n    label: About basics\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"disable-page-actions","__idx":10},"children":["Disable page actions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example disables the page actions on all pages of the project."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"navigation:\n  actions:\n    hide: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"customize-page-actions","__idx":11},"children":["Customize page actions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example includes only the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["copy"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["view"]}," actions, which hides the AI-related (ChatGPT, Claude) and MCP actions."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"navigation:\n  actions:\n    items:\n      - copy\n      - view\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":12},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/front-matter-config"},"children":["Front matter configuration options"]}]}," - Configure navigation button options on individual pages using front matter for granular control"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config"},"children":["Configuration options"]}]}," - Explore other project configuration options for comprehensive documentation and platform customization"]}]}]},"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"description":"Control the Previous and Next navigation buttons on project pages."},"tagList":["configOptionRequirements","html","partial","table"],"title":"navigation","lastModified":"2026-10-07T09:46:14.000Z"}