文档模块规范
module-docs 提供开箱即用的类 Docusaurus 三级文档系统,兼顾大型多卷技术手册的侧栏紧凑性与搜索引擎长尾词友好度。
目录结构约定
assets/docs/
├── guide/ # 一级分卷:/docs/guide
│ ├── index.md # 分卷首页(可选;若无则仅作侧栏折叠分组)
│ ├── quickstart/
│ │ └── index.md # 二级章节:/docs/guide/quickstart
│ └── advanced/
│ └── ssr/
│ └── index.md # 三级小节:/docs/guide/advanced/ssr
└── changelog/
├── index.md # 设置 sort_children: desc 让最新期排最前
├── v0-7-0/index.md
└── v0-7-1/index.md
- 以
_或.开头的目录(如_drafts)在构建目录树与搜索索引时会自动忽略。 - 同时支持
index.md与index.mdx(优先匹配.mdx)。
Frontmatter 元数据字段
---
title: Axum 常见坑与报错排查:Handler 不满足、路由冲突与中间件顺序
sidebar_label: 常见坑
sidebar_position: 10
description: 汇总 Axum 开发中最常遇到的编译期 trait 报错与运行期请求体消费陷阱。
keywords: [axum, FromRequest, Handler trait, 常见报错]
sort_children: asc
source:
crate: axum
version: "0.8.4"
---
几个实用设计细节
title与sidebar_label读写分离:左侧目录树与上下篇卡片优先显示简短的sidebar_label(如常见坑),而页面 HTML<title>、og:title与 JSON-LDTechArticle.headline使用信息量完整的title。- 子章节自动补齐所属卷名:若子章节只写了简短标题(如
title: 路由与提取器),服务端在输出 SEO 元信息与写入 Tantivy 搜索索引时会自动补齐为路由与提取器 · Axum,彻底消除多卷同名章节在 Google 收录与⌘K搜索中的重复与歧义。 source版本徽章:配置source.crate与source.version后,正文顶部会自动渲染指向https://docs.rs/<crate>/<version>的版本胶囊,并在 Schema.org 结构化数据中注入SoftwareSourceCode关联。- 安全面包屑与编辑链接:详情页顶部自动生成
文档 / 分卷 / 章节面包屑(纯分组无正文目录自动降级为纯文本,绝不产生 404 死链);配置site.json::docs_edit_url_base后底部自动附带 GitHub 编辑入口。

