Frontmatter Reference

Frontmatter is YAML metadata at the top of every page. It controls page display and navigation behavior.

Required Fields

Every page must have these:

title

Page title that appears in browser tab and sidebar.

---
title: "Getting Started"
---

description

Short description for SEO and preview text.

---
description: "Learn how to get started with CelestialDocs in 5 minutes"
---

navLabel

Override the sidebar label (if different from title).

---
title: "Installation and Configuration"
navLabel: "Install"  <- Sidebar shows this instead
---

navIcon

Add an icon in the sidebar next to the entry.

---
navIcon: "⚡"  <- Emoji
---

---
navIcon: "document"  <- SVG reference
---

navHidden

Hide from navigation but keep accessible via URL.

---
navHidden: true
---

Page won’t appear in sidebar but users can still visit it directly.

Optional Metadata Fields

draft

Exclude from production builds.

---
draft: true  <- Skipped in build
---

Useful for work-in-progress pages.

authors

List page authors.

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

Complete Example

---
title: "Advanced Configuration"
description: "Learn how to configure CelestialDocs for enterprise deployments"
navLabel: "Advanced Config"
navIcon: "⚙️"
navHidden: false
draft: false
authors: ["Alice", "Bob"]
tags: ["configuration", "advanced", "enterprise"]
---
# Advanced Configuration

Content goes here...

Field Types

Field	Type	Default	Notes
title	string	required	Page title
description	string	required	SEO description
navLabel	string	optional	Override sidebar text
navIcon	string	optional	Emoji or SVG ref
navHidden	boolean	false	Hide from nav?
draft	boolean	false	Work in progress?
authors	array	[]	Page authors
tags	array	[]	Page tags

Common Patterns

Tutorial Page

---
title: "Building Your First App"
description: "Step-by-step guide to building your first application"
navLabel: "First App"
navIcon: "🚀"
authors: ["Your Name"]
tags: ["tutorial", "beginner"]
---

Reference Page

---
title: "API Endpoints Reference"
description: "Complete reference for all REST API endpoints"
navLabel: "Endpoints"
navIcon: "📡"
draft: false
tags: ["api", "reference"]
---

Draft/WIP

---
title: "Upcoming Features"
description: "Features we're working on"
draft: true
navHidden: true
---

Hidden But Accessible

---
title: "Internal Documentation"
description: "Internal team documentation"
navHidden: true
---

Tips

Keep titles short (3-5 words)

title: "Getting Started"          ✅ Good
title: "How to Get Started with CelestialDocs" ❌ Too long

Use navLabel for long titles

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

Use navHidden for drafts
```
draft: true
navHidden: true
```
Add authors for accountability
```
authors: ["Alice", "Bob", "Charlie"]
```

Use consistent icon style

navIcon: "🚀"  # Emoji for visual variety
navIcon: "book" # Or SVG for consistency

Next Steps

Learn about:

Search Documentation