文章

内置文档系统如何工作

web-sveltekit 内的 Markdown 文档机制,以及如何扩展。

站内文档基于本地 Markdown,由 SvelteKit 加载,而不是 Nuxt Content。

已包含内容

  • 路由页 /docs/docs/[slug](以及 /zh-CN/docs/*
  • Markdown 存放在 src/content/docs/
  • 英文与简体中文分别在 en/zh/
  • 文档路由具备 SEO 元数据与 sitemap 覆盖
  • 侧栏导航由同一内容源生成

语言行为

公开站目前启动英文与简体中文。文档源遵循同样规则:英文始终可用,简体中文按需提供。

如何新增一页

1. 在 src/content/docs/en/ 添加 markdown 2. 如需中文,在 src/content/docs/zh/ 添加同名文件 3. 使用 frontmatter 配置 titlelabeldescriptionorder

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

## Overview

在这里写正文。

下一步扩展

文档量增长后,可在保持公开 /docs 路由与 frontmatter 形状的前提下,增加搜索、更丰富的导航元数据或远端内容源。

上一篇