ZuploZuplo
LoginStart for Free
  • Documentation
  • API Reference
Introduction
Getting Started
    Develop using the Portal
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth4 - Deploy5 - Dynamic Rate LimitingMCP - Quick start
    Develop Locally
      1 - Setup Your Gateway2 - Rate Limiting3 - API Key Auth
Concepts
Development
Policies
Handlers
API Keys
MCP Server
MCP Gateway
AI Gateway
Developer Portal
    IntroductionLocal DevelopmentUpdating VersionsNode Modules & Customization
    Configuration
    Writing
      MarkdownFrontmatterMDXAdmonitionsCode Blocks
    OpenAPI
    Authentication
    Integrations
    Guides
    Extending
    Components
Monetization
Deploying & Source Control
Observability
Networking & Infrastructure
Account Management
Programming API
Build with AI
Zuplo CLI
Migration Guides
Platform LimitsSecuritySupportTrust & ComplianceChangelog
powered by Zudoku
Writing

Frontmatter

Frontmatter is metadata written in YAML format at the beginning of markdown files, enclosed between triple dashes (---). It allows you to configure various aspects of your pages without affecting the visible content.

In Zudoku, frontmatter enables you to customize page titles, descriptions, navigation settings, and other document properties. Here are all the supported properties:

Properties

title

Sets the page title that appears in the browser tab and as the document title.

Code
--- title: My Page Title ---

description

Provides a description for the page, which can be used for SEO and content summaries.

Code
--- description: This page explains how to use Zudoku's markdown features. ---

category

Assigns the page to a specific category for organizational purposes. This will be shown above the main heading of the document.

Code
--- category: Getting Started ---

sidebar_label

Sets a custom label for the page in the sidebar navigation, allowing you to use a shorter or different title than the main page title.

Code
--- title: My Very Long Documentation Page Title sidebar_label: Short Title ---

The legacy name navigation_label is also supported but sidebar_label is preferred.

sidebar_icon

Specifies a Lucide icon to display next to the page in the sidebar navigation.

Code
--- sidebar_icon: compass ---

The legacy name navigation_icon is also supported but sidebar_icon is preferred.

navigation_display

Specifies the display property of the navigation item. See the Navigation guide

Code
--- navigation_display: auth ---

toc

Controls whether the table of contents is displayed for the page. Set to false to hide the table of contents.

Code
--- toc: false ---

fullWidth

Removes the table of contents sidebar and lets the page content span the full available width. When enabled, the table of contents is still accessible via an "On this page" toggle in the page header (unless toc: false is also set, in which case it is hidden entirely).

Code
--- fullWidth: true ---
fullWidthtocResult
falsetrueTOC shown in the sidebar (default).
falsefalseTOC hidden; content keeps its standard width.
truetrueContent spans full width; TOC is available via a toggle button.
truefalseContent spans full width; TOC is not available at all.

disable_pager

Controls whether the previous/next page navigation is displayed at the bottom of the page. Set to true to disable it.

Code
--- disable_pager: true ---

showLastModified

Controls whether the last modified date is displayed for this page. Can be used to override the default option.

Code
--- showLastModified: false ---

draft

Marks a document as a draft. Draft documents are only visible when running in development mode and are excluded from production builds. This is useful for working on content that isn't ready to be published.

Code
--- draft: true ---

When draft: true is set:

  • The document will be visible when running zudoku dev
  • The document will be excluded from builds created with zudoku build
  • The document won't appear in the navigation or be accessible via URL in production

lastModifiedTime

The last modified timestamp for the page. This property is automatically set by Dev Portal during the build process based on the Git commit history. You generally should not set this manually.

If you need to override the automatically detected date, you can set it explicitly:

Code
--- lastModifiedTime: 2025-11-20T10:30:00.000Z ---

Complete Example

Here's an example showing multiple frontmatter properties used together:

documentation.md
--- title: Advanced Configuration Guide description: Learn how to configure advanced features in Dev Portal category: Configuration sidebar_label: Advanced Config sidebar_icon: settings toc: true disable_pager: false draft: false --- This page content follows the frontmatter...
Edit this page
Last modified on May 29, 2026
MarkdownMDX
On this page
  • Properties
    • title
    • description
    • category
    • sidebar_label
    • sidebar_icon
    • navigation_display
    • toc
    • fullWidth
    • disable_pager
    • showLastModified
    • draft
    • lastModifiedTime
  • Complete Example
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown
Markdown