Frontmatter

Frontmatter

Frontmatter is the data at the top part of a markdown file that can be found between two sets of dashes.

---
id: 1
---

Markdown content

We support the following frontmatter in our documentation:

KeyDescription
alias_pathsA list of paths to redirect from to this page. Used to smoothly redirect old URLs to new ones
centeredWraps a page (not a guide) in a <Centered> element in order to center the content in the middle of the page.
hideHides this page from search.
hide_in_page_navHides the right-hand in-page navigation.
hide_step_numberHides the step number in the left-hand sidebar for quick start guides.
hide_titleHide the title of a page. Used on the homepage.
rankThe rank of a page. This is used to sort pages in the sidebar and other lists of pages.
related_endpointsA list of endpoint IDs (for example get_files_id) that are related to this guide/page. These are shown at the bottom of the page, after the markdown content.
related_guidesA list of guide IDs (for example tooling/postman) that are related to this guide/page. These are shown at the bottom of the page, after the markdown content.
related_pagesA list of page IDs (for example sdks-and-tooling) that are related to this guide/page. These are shown at the bottom of the page, after the markdown content.
related_resourcesA list of resource IDs (for example file) that are related to this guide/page. These are shown at the bottom of the page, after the markdown content.
required_guidesA list of prerequisite guide IDs (for example tooling/postman) that are required reading for this guide/page. These are shown at the top of the page, after the title but before the markdown content.
typeAn optional type of guide / page that this represents. The only valid value for now is a quick-start guide.