Plainform | Create Doc Section

Learn how to organize your documentation by creating new sections with multiple pages.

Goal

By the end of this recipe, you'll have created a new documentation section with its own navigation and pages.

Prerequisites

A working Plainform installation
Basic knowledge of Markdown/MDX syntax

Steps

Create Section Directory

Create a new folder in content/docs/:

mkdir content/docs/your-section

Use lowercase letters and hyphens (e.g., api-reference, user-guides).

Create meta.json

Create a meta.json file in your section directory:

content/docs/your-section/meta.json

{
  "title": "Your Section Title",
  "description": "Brief description of this section",
  "icon": "BookOpen",
  "pages": [
    "overview",
    "getting-started"
  ]
}

Create Section Pages

Create MDX files for each page listed in meta.json:

content/docs/your-section/overview.mdx

---
title: Overview
description: Introduction to this section
icon: Info
---

# Overview

Your content here...

Update the root meta.json:

content/docs/meta.json

{
  "title": "Documentation",
  "pages": [
    "---Getting Started---",
    "introduction",
    "---Your Section---",
    "your-section"
  ]
}

Use ---Section Name--- to create navigation separators.

Preview and Publish

Start your dev server:

npm run dev

Then commit and push:

git add content/docs/
git commit -m "docs: add new documentation section"
git push origin main

Common Issues

Section Not Appearing

Verify meta.json exists in the section directory
Check that the section is listed in root meta.json
Ensure JSON is valid (no trailing commas)

Pages Not Showing

Confirm page slugs in meta.json match filenames
Check that MDX files exist in the correct location

Next Steps

Add Doc Page - Add pages to your section
Customize Theme - Customize the docs appearance

Fumadocs Page Tree - Page organization
Fumadocs Navigation - Navigation configuration

Create Doc Section