Skip to content

Frontmatter

Define page-specific metadata

You can set page-specific metadata such as the page title and description in the frontmatter of Markdown pages. The frontmatter is a YAML block encapulated in a --- separator at the top of the page.

example.md
---
title: Example
description: This is an example page.
---
 
# Hello world
 
This is me.

authors

  • Type: string[]

Authors of the page. Used by the ::authors markdown directive.

---
authors: 
  - [jxom](https://x.com/jxom)
  - [awkweb](https://x.com/awkweb)
---
 
# gm
 
::authors  # [!code focus]
 
we're so back

content

  • Type: 
{
  horizontalPadding: string
  width: string
  verticalPadding: string
}

Page content attributes.

  • horizontalPadding: Horizontal padding of the content.
  • width: Width of the content.
  • verticalPadding: Vertical padding of the content.
---
content:  
  horizontalPadding: 0px
  width: 100%
  verticalPadding: 0px
---
 
# gm
 
we're so back

date

  • Type: string

Authors of the page. Used by the ::authors markdown directive.

---
authors: 
  - [jxom](https://x.com/jxom) 
  - [awkweb](https://x.com/awkweb) 
date: 2023-12-01
---
 
# gm
 
::authors
 
we're so back

description

  • Type: string

Description of the page. Placed in the <meta name="description"> tag.

---
description: This is an example page.
---

layout

  • Type: "docs" | "landing" | "minimal"
  • Default: "docs"

Layout of the page.

  • docs - Documentation page layout (default).
  • landing - Landing page layout.
  • minimal - A minimal layout with no sidebar or header.
---
layout: minimal
---

searchable

  • Type: boolean
  • Default: true

Whether or not the page should be included in search results. Set to false to exclude the page from the search index.

---
searchable: false
---

showAiCta

  • Type: boolean

Whether or not to display the AI call-to-action dropdown (ie. "Open in ChatGPT").

---
showAiCta: false
---

showLogo

  • Type: boolean

Whether or not to display the logo in the header.

---
showLogo: false
---

showOutline

  • Type: number | boolean

Whether or not to display the outline, or the number of levels deep.

---
showOutline: false
---
---
showOutline: 2
---

showSidebar

  • Type: boolean

Whether or not to display the sidebar.

---
showSidebar: false
---

title

  • Type: string

Title of the page. Placed in the <title> tag.

---
title: Example
---