⌂ home

Frontmatter

Additional page information can be provided via frontmatter. Frontmatter is always added to the top of a markdown file, and delimited by 3 hypens.

For example:

---
foo: bar
---

# My page title

My page content...

We support the following values in frontmatter:

---
seo:
  title: [string]
  description: [string]
navOrder: [number]
---

SEO frontmatter

The SEO section in the frontmatter should be used on every page. This ensures that our documentation can be indexed by search engines. To add SEO details to a page, you may do the following:

---
seo:
  title: My page title
  description: A description of the content of this page
# ... other frontmatter
---

The order of navigation items can be controlled using the navOrder property in a page’s frontmatter:

---
navOrder: 1
#...other properties
---

Navigation items are ordered using the following rules:

  • pages with a navOrder value are given priority over those that don’t
  • pages at the same depth in the directory structure with the same navOrder value are ordered by alphabetically by the first title found on each page
  • the navOrder value on an index page is used to sort the containing folder relative to its sibling folders and pages
  • pages without a navOrder value are sorted alphabetically