Frontmatter Reference

You can customize individual Markdown and MDX pages in CelestialDocs by setting values in their frontmatter. For example, a regular page might set title and description fields.

---
title: Sample
description: Sample description
---

Page content goes here, after `---`.

This document describes the available frontmatter properties for your content files. Frontmatter is a block of metadata that provides context and configuration for your content. Below is a detailed reference for each property, including their types, default values, and descriptions.

Properties

title

  • Type: string
  • Description: The title of the content. This is a required field that represents the main heading or name of your document.

author

  • Type: string
  • Default: The author defined in the site configuration (SITE.author)
  • Description: The name of the person or entity responsible for creating the content. If not specified, it defaults to the author defined in the site’s configuration.

pubDatetime

  • Type: Date (optional)
  • Description: The date and time when the content was published. This field is optional and can be used to specify when the content was made available.

modDatetime

  • Type: Date (optional, nullable)
  • Description: The date and time when the content was last modified. This field is optional and can be null if no modification has occurred. It helps track the latest changes made to the content.

description

  • Type: string (optional)
  • Description: A brief summary or description of the content. This optional field provides additional context or a teaser for the document.

draft

  • Type: boolean
  • Default: false
  • Description: Indicates whether the content is a draft. If set to true, the content is considered a draft and may not be published or visible on the site.

tags

  • Type: array of strings
  • Default: [] (empty array)
  • Description: A list of tags associated with the content. Tags can be used for categorization and filtering purposes. The default is an empty array, meaning no tags are assigned unless specified.

hide_breadcrumbs

  • Type: boolean (optional)
  • Default: false
  • Description: Determines whether breadcrumbs should be hidden for the content. If set to true, breadcrumbs will not be displayed. This is useful for customizing the navigation experience.

hide_toc

  • Type: boolean (optional)
  • Default: false
  • Description: Specifies whether the Table of Contents (ToC) should be hidden. Setting this to true will prevent the ToC from being shown, allowing for a cleaner layout if the ToC is not needed.

hide_sidenav

  • Type: boolean (optional)
  • Default: false
  • Description: Indicates whether the sidebar navigation should be hidden. If set to true, the sidebar will not be displayed, which can be useful for pages where a sidebar is unnecessary.

max_width

  • Type: boolean (optional)
  • Default: false
  • Description: Controls whether the content should use the maximum available width. Setting this to true allows the content to stretch to the full width of the container, providing a more expansive layout.

This reference guide should help you configure the frontmatter for your content effectively. Adjust these properties to control various aspects of how your content is presented and organized.