Article

How the built-in docs work

The Markdown docs setup inside web-sveltekit and how to extend it.

The in-app docs run on local Markdown files loaded through SvelteKit, not Nuxt Content.

What is included

  • Route-backed docs pages under /docs and /docs/[slug] (plus /zh-CN/docs/*)
  • Markdown files stored under src/content/docs/
  • English and Simplified Chinese collections under en/ and zh/
  • SEO metadata and sitemap coverage for the docs routes
  • Shared sidebar navigation generated from the same content source

Locale behavior

The public site currently launches in English and Simplified Chinese. The docs source follows the same rule: English is always available, Simplified Chinese is added where it exists.

How to add a page

1. Add a markdown file under src/content/docs/en/ 2. Add the matching Chinese file under src/content/docs/zh/ if you want localized content 3. Use frontmatter for title, label, description, and order

---
title: Billing guide
label: Billing
description: Explain plans, invoices, and credits.
order: 4
---

## Overview

Add your content here.

Where to extend next

If docs volume grows, the next step is search, richer navigation metadata, or a remote content source — while keeping the same public /docs routes and frontmatter shape.

Previous