Back to docs

Documentation

How the built-in docs work

The Nuxt Content docs setup inside web-nuxt and how to extend it.

Article
Previous

The in-app docs run on Nuxt Content instead of a custom parser.

What is included

  • Route-backed docs pages under /docs and /docs/[slug]
  • Markdown files stored under content/docs/
  • content.config.ts collections for English and Simplified Chinese docs
  • SEO metadata and prerender 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, and retired locale routes should redirect back to the canonical English or Simplified Chinese path.

How to add a page

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

Where to extend next

If docs volume grows, build on the same Nuxt Content workflow with search, navigation metadata, or remote content sources instead of replacing the stack again.