Documentation architecture
A sample technical article describing how this documentation app is built.
This sample reference describes the documentation app. It is a starting point for future technical articles.
How articles become pages
Articles live in apps/docs/src/content/ as Markdown files. mdsvex compiles their
content into Svelte components, and SvelteKit prerenders the pages into static HTML.
The file path determines the public URL:
| Markdown file | URL |
|---|---|
tutorials/getting-started.md | /tutorials/getting-started/ |
technical/documentation-architecture.md | /technical/documentation-architecture/ |
Article metadata
Every article starts with YAML frontmatter. The title and description appear on
the article page and in its HTML metadata; order controls its position in the article list.
---
title: Your article title
description: A short summary of what the reader will learn.
order: 3
---Start the article body with a second-level heading (##). The page already displays
the frontmatter title as its main heading.
Build and hosting
Run these commands from the repository root:
pnpm --filter docs check
pnpm build:docsThe static site is generated in apps/docs/build/. The Wrangler configuration
points Cloudflare Workers Static Assets at that directory.
Article pages mark their content with data-pagefind-body for future search indexing.
Pagefind is installed; the indexing step and search interface are still pending.
Related tutorial
Return to Getting started for an example of a step-by-step article.