Book 分区配置
场景与目标¶
当书籍章节较多时,可以通过 Part 将章节按逻辑单元分组,侧边栏会按 Part 分段并支持折叠。Part 定义集中在书籍根 _index.md,各章节只声明 part_id。
配置步骤¶
- 在书籍根
_index.md定义 Parts(唯一来源)
parts:
- id: part-i
title: "Part I · 基础架构与核心抽象"
order: 1
collapse: false # 可选,当前实现默认展开
- id: part-ii
title: "Part II · 平台能力与生产实践"
order: 2
collapse: false
- id: part-iii
title: "Part III · 扩展机制与新范式"
order: 3
collapse: false
id用于章节引用,需全局唯一。order控制 Part 顺序;title为侧栏显示文案。-
仅书籍根定义 Part,其他地方不要重复定义。
-
在章节
_index.md绑定 Part
---
title: 集群资源管理
weight: 21
part_id: part-i
---
- 章节只声明
part_id,不要重复配置title/order/collapse。 -
未设置
part_id的章节会落到“未分组章节”兜底分组。 -
渲染与样式行为
-
侧栏模板
layouts/partials/book/book-sidebar.html会:- 读取书籍根的
parts,按order排序渲染; - 按
part_id分组章节;未分配的章节单独汇总; - 显示书籍首页节点(包含 icon)。
- 读取书籍根的
- 样式位于
assets/scss/layouts/book/_sidebar.scss,可调节 Part 标题间距、颜色和展开状态。
最佳实践¶
- 先确定书籍的 3–5 个核心脉络,再映射
part_id,避免过度细分。 - 调整分组顺序或文案时,仅编辑书籍根
_index.md的parts段。 - 保持章节
weight有序,以便 Part 内排序稳定。