Plainform | Add Doc Page

Learn how to create a new documentation page in your Plainform application.

Goal

By the end of this recipe, you'll have created a new documentation page with proper metadata and navigation.

Prerequisites

A working Plainform installation
Basic knowledge of Markdown/MDX syntax

Example files included: Plainform includes example documentation files in content/docs/module-1/, module-2/, and module-3/ folders. These show you the structure with example-doc-page.mdx files and meta.json configuration. You can use them as references and delete them when you're ready to add your own content.

Steps

Create MDX File

Create a new .mdx file in the appropriate section:

# Example locations
content/docs/core/new-topic.mdx
content/docs/core/authentication/new-feature.mdx

Use lowercase letters and hyphens for filenames. The filename becomes the URL slug.

Add Frontmatter

Add frontmatter at the top of your file:

---
title: Your Page Title
description: A brief description of the page content
icon: BookOpen
---

# Your Page Title

Your content here...

Browse available icons at lucide.dev.

Update the meta.json file in the same directory:

content/docs/core/meta.json

{
  "title": "Core Documentation",
  "pages": [
    "introduction",
    "new-topic"
  ]
}

The page slug in meta.json must match the filename without the .mdx extension.

Preview and Publish

Start your dev server and navigate to your page:

npm run dev

Then commit and push:

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

Common Issues

Page Not Appearing

Verify the page is listed in meta.json
Check that the slug matches the filename exactly
Ensure meta.json is valid JSON (no trailing commas)

404 Error

Confirm the file is in the correct directory
Check that the file has .mdx extension
Verify frontmatter is properly formatted with --- markers

Next Steps

Create Doc Section - Organize pages into sections
Customize Theme - Customize the docs appearance

Fumadocs MDX - Available MDX components
Fumadocs Page Configuration - Page configuration options

Add Doc Page