Skip to Content
ftsfn ref

writing pages

where a page goes, its frontmatter, and how the sidebar is ordered

where a page goes

every page is an .mdx file under content/docs/, its path is its url, content/docs/engine/ecs.mdx is /engine/ecs. each top level folder with "root": true in its meta.json is a section, its own sidebar and a tab in the switcher. a new section is a new folder with a meta.json and an index.mdx, plus a line in the top meta.json

frontmatter

---
title: entity component systems
description: one line, shows under the title, in search and on the og card
---

a page ref-page wrote off a transcript also carries plan: (its file in ref/plans/), transcripts: (a list, a page can be built up out of several), tags: and stub: true when it is a thin topic waiting to grow or merge, all four optional

a folders meta.json lists its pages in order, "..." stands for the rest alphabetically, a "---label---" entry is a heading in the sidebar

{
	"title": "engine",
	"root": true,
	"pages": ["index", "---rendering---", "pipeline", "materials", "---the rest---", "..."]
}

names that are taken

the site serves /api/search, /og/..., /llms.txt, /llms-full.txt and /llms.mdx/..., so no section or page called api, og, or anything starting with llms

On this page