Help articles are markdown files stored in the content/articles/ directory, organized by category.
Creating an article
Create a new .md file in the appropriate category folder:
content/articles/getting-started/my-article.md
Every article needs a frontmatter header:
---
title: "My Article Title"
slug: "my-article-title"
category: "getting-started"
description: "A short description for search and previews."
order: 5
faq: false
createdAt: "2026-02-13"
updatedAt: "2026-02-13"
---
Your article content goes here in markdown.
Frontmatter fields
| Field | Required | Description |
|---|---|---|
title | Yes | The article title displayed on the page |
slug | Yes | URL-safe identifier — must be unique across all articles |
category | Yes | Must match the folder name and a category in src/lib/categories.ts |
description | Yes | Short summary for search results and previews |
order | Yes | Sort position within the category (lower numbers appear first) |
faq | No | Set to true to include in the FAQ section on the homepage |
createdAt | Yes | Creation date in YYYY-MM-DD format |
updatedAt | Yes | Last updated date in YYYY-MM-DD format |
Writing tips
- No h1 heading — Don't include a
# Titlein the body. The title is rendered from the frontmatter. - Use h2 and h3 — Structure your content with
## Sectionand### Subsectionheadings. - Link to other articles — Use relative links like
[Configuration](/article/configuration). - Keep it concise — Short, focused articles are easier to find and read than long ones.
Adding images
Place images in public/images/articles/ and reference them in your markdown:
Categories
Articles are organized into categories defined in src/lib/categories.ts. The default categories are:
getting-started— Setup and onboardingfeatures— Feature documentationtroubleshooting— Problem-solving guides
You can add, remove, or rename categories by editing the categories array in that file. Each category needs a slug, title, description, and icon.
Building
After adding or editing articles, rebuild the search index so they appear in search results:
npm run build:search
npm run build:content
In development, article pages render dynamically, but search and beacon content are static.