Skip to main content

Front Matter

Updated Mar 12, 2025 ·

Overview​

Specify properties for the docs files. It is the YAML file at the top of the docs page.

---
title: Put Main Title of Page here
sidebar_position: 2                   # Ordering of display on the sidebar
toc_min_heading_level: 1              # TOC at the right, shows min Header 1 level
toc_max_heading_level: 6              # TOC at the right, shows max Header 6 level
---

Description​

The description will appear as the brief description or a preview of the doc. As an example:

---
title: "Networking Basics"
description: "Learn the basics of Networking"
tags: [Networking,Cybersecurity]
sidebar_position: 1
last_update:
  date: 1/30/2024
---

When rendered, it will look like this:

TOC​

If you want to also show the TOC at the main page, besides the TOC at the right, add the following after the front matter section, like this:

---
title: Put Main Title of Page here
sidebar_position: 2                   # Ordering of display on the sidebar
toc_min_heading_level: 1              # TOC at the right, shows min Header 1 level
toc_max_heading_level: 6              # TOC at the right, shows max Header 6 level
--- 

import TOCInline from '@theme/TOCInline

<TOCInline toc={toc} minHeadingLevel=}{2} maxHeadingLevel=}{6} />>