Plainform

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.

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 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.

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