Getting Started

Usage

Learn the day-to-day authoring flow for MDX docs, sections, and navigation.

authoringmdxworkflow

Usage

Create a new page

  1. Add a file under content/docs.
  2. Include frontmatter with title, description, section, order, updated, and tags.
  3. Use ## and ### headings to populate the table of contents automatically.

Frontmatter example

---
title: API Authentication
description: How to authenticate requests with personal access tokens.
section: Guides
order: 4
updated: 2026-04-19
tags:
- api
- authentication
---
  • The sidebar is generated from page frontmatter.
  • section groups pages.
  • order controls the position within the section.
  • Previous/next links are generated from page order.

Search behavior

Search indexes page titles, descriptions, section names, and headings.

Content conventions

  • Keep one core topic per page.
  • Put procedural steps in numbered lists.
  • Use concise headings for better scanability and TOC quality.

Updated 2026-04-19