文档首页
文档系统
说明双语 markdown 文档如何通过 Content Collections、wikilinks 和 callout 进行管理。
文档系统
文档层基于 Astro Content Collections 构建,这样路由、frontmatter 和 locale 配对都能保持类型安全。
Collection 强制执行的规则
- locale 只允许
en和zh。 - 每篇文档都必须声明
translationKey。 - 每个 locale 都必须对每个 translation key 恰好提供一份文件。
- 路由 slug 保持稳定,这样
[[wikilink]]的目标可以足够简单。
如果某个 locale 缺少文档配对,helper 会在内容加载阶段直接抛错,而不是悄悄上线一个不完整的 docs tree。
Markdown 增强
[[overview]]会被转成当前 locale 对应的 docs 链接。[[shipping-model|交付指南]]会使用 alias 作为链接文本。> [!TIP]这类 block 会通过 remark plugin 变成有样式的 callout。
这样做的价值
整个 docs 体验仍然很轻,因为只有内容页本身和极少量辅助 UI 会加载,完全不需要 client-side router。
如果你要回到整体站点结构,可以打开 总览。