Frontmatter
Complete reference for all available frontmatter fields in zudo-doc documents.
Every MDX file in zudo-doc starts with a YAML frontmatter block delimited by ---. This page documents all available fields.
Complete Example
---
title: My Documentation Page
description: A comprehensive guide to something important.
sidebar_position: 3
sidebar_label: My Page
tags: [tutorial, setup]
---
Your content here.Minimal Example
Only title is required:
---
title: Quick Start
---Field Overview
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
title | string | Yes | — | Page title shown in heading, sidebar, and browser tab |
description | string | No | — | Subtitle shown below the title |
sidebar_position | number | No | 999 | Sort order within the sidebar category |
sidebar_label | string | No | Value of title | Override label shown in sidebar |
category | string | No | Directory name | Reserved for future use |
search_exclude | boolean | No | false | Exclude the page from search indexing |
tags | string[] | No | — | Tags for cross-cutting navigation |
draft | boolean | No | false | Exclude from production build (visible in dev) |
unlisted | boolean | No | false | Built but hidden from sidebar, search, and search engines |
hide_sidebar | boolean | No | false | Hide the left sidebar, center content in a narrower container |
hide_toc | boolean | No | false | Hide the right-side table of contents |
standalone | boolean | No | false | Hidden from sidebar nav but still indexed (unlike unlisted) |
slug | string | No | Derived from file path | Custom URL slug override |
pagination_next | string | null | No | Auto | Override next page link, set to null to hide |
pagination_prev | string | null | No | Auto | Override previous page link, set to null to hide |
Fields
title
- Type:
string - Required: Yes
The page title. It is displayed as the h1 heading on the page, in the sidebar navigation, in the browser tab, and in search results.
---
title: Getting Started with zudo-doc
---description
- Type:
string - Required: No
A short description or subtitle for the page. Shown below the title on the rendered page. Also useful for SEO meta tags.
---
title: Installation
description: How to install and set up zudo-doc for your project.
---sidebar_position
- Type:
number - Required: No
- Default:
999(appears at the end)
Controls the sort order of the page within its sidebar category. Lower numbers appear first.
---
title: Introduction
sidebar_position: 1
---💡 Tip
For category index pages (index.mdx), the sidebar_position also controls where the entire category appears relative to other categories in the sidebar.
sidebar_label
- Type:
string - Required: No
- Default: Value of
title
Overrides the label displayed in the sidebar navigation. Use this when you want a shorter or different label than the full page title.
---
title: Configuring Color Schemes and Themes
sidebar_label: Color Schemes
---category
- Type:
string - Required: No
- Default: Derived from the directory structure (first directory segment)
Reserved for future use. This field is defined in the content schema but is not currently used by the sidebar or routing logic. Categories are always derived from the directory structure.
📝 Note
Organize pages into categories by placing them in directories under src/content/docs/. The directory name becomes the category name.
search_exclude
- Type:
boolean - Required: No
- Default:
false
When set to true, excludes the page from the search index. Useful for internal pages, changelogs, or imported content that should not appear in search results.
---
title: Internal Changelog
search_exclude: true
---tags
- Type:
string[] - Required: No
Assigns tags to the page for cross-cutting navigation. Tags are displayed as clickable badges on the page, and tag index pages are auto-generated at /docs/tags/ and /docs/tags/[tag].
---
title: Deploying to Netlify
tags: [deployment, netlify, hosting]
---💡 Tip
Tags are useful for grouping related pages across different sidebar categories.
draft
- Type:
boolean - Required: No
- Default:
false
When set to true, the page is excluded from the production build entirely. Draft pages are still visible during development (pnpm dev) for preview purposes.
---
title: Upcoming Feature
draft: true
---unlisted
- Type:
boolean - Required: No
- Default:
false
When set to true, the page is built and accessible via its URL, but is hidden from the sidebar navigation, search index, and search engines (via noindex meta tag).
---
title: Internal Notes
unlisted: true
---hide_sidebar
- Type:
boolean - Required: No
- Default:
false
When set to true, the left sidebar is hidden on desktop and the content is centered in a narrower container. The mobile hamburger menu still provides access to navigation. Useful for landing pages, standalone articles, or any page where a full-width reading experience is preferred.
---
title: About This Project
hide_sidebar: true
---ℹ️ Info
See the live demo to experience this layout option in action.
hide_toc
- Type:
boolean - Required: No
- Default:
false
When set to true, the right-side table of contents (section navigation) and the mobile TOC are both hidden. The main content area expands to fill the available width.
---
title: Changelog
hide_toc: true
---ℹ️ Info
See the live demo to experience this layout option in action.
💡 Tip
Combine hide_sidebar and hide_toc to create a clean, centered reading layout with no navigation panels:
---
title: About
hide_sidebar: true
hide_toc: true
---See the live demo to see both options combined.
standalone
- Type:
boolean - Required: No
- Default:
false
When set to true, the page is hidden from sidebar navigation and site index but remains accessible via its URL and is still indexed by search engines. Unlike unlisted, standalone pages do not get a noindex meta tag.
---
title: Terms of Service
standalone: true
---📝 Note
Use standalone for pages that should be publicly accessible but don’t belong in the documentation navigation (e.g., legal pages, special landing pages). Use unlisted when you also want to prevent search engine indexing.
slug
- Type:
string - Required: No
- Default: Derived from the file path
Overrides the URL slug for the page. Use this when you want a different URL than what the file path would produce.
---
title: Getting Started with zudo-doc
slug: quickstart
---This page would be accessible at /docs/quickstart instead of the default path derived from its file location.
pagination_next
- Type:
string | null - Required: No
- Default: Automatically determined by sidebar order
Overrides the “Next” page link shown at the bottom of the document. Set to a document path (e.g., "guides/configuration") to link to a specific page, or set to null to hide the next link entirely.
---
title: Final Step
pagination_next: null
---pagination_prev
- Type:
string | null - Required: No
- Default: Automatically determined by sidebar order
Overrides the “Previous” page link shown at the bottom of the document. Set to a document path (e.g., "getting-started/introduction") to link to a specific page, or set to null to hide the previous link entirely.
---
title: Getting Started
pagination_prev: null
---