Search Documentation

Search for pages and headings in the documentation

Optional Frontmatter Fields

Optional fields refine how pages appear and behave. Use them when they add clarity—skip them when they do not.

Shorten or rename the sidebar label without changing the title.

---
title: "Frequently Asked Questions About Deployment"
navLabel: "Deployment FAQ"
---

Add visual affordance in the sidebar.

---
navIcon: "🚀"   # Emoji
# or
navIcon: "book" # Icon name from your icon set
---

Hide the page from navigation while keeping the URL accessible (useful for drafts or landing pages).

---
navHidden: true
---

draft

Exclude the page from production builds.

---
draft: true
---

authors

Credit contributors or set ownership.

---
authors: ["Alice", "Bob"]
---

tags (custom)

If you extend the schema, tags help grouping or search.

---
tags: ["api", "reference", "v2"]
---

When to Use Optional Fields

  • Use navLabel for long titles
  • Use navIcon sparingly so the sidebar stays consistent
  • Use navHidden + draft during in-flight work
  • Add authors for high-ownership pages (SLAs, runbooks)

Next Steps