mdBook 是一个基于 Rust 的工具,用于从 Markdown 生成书籍。该技能提供 mdBook 的完整参考,内容自动生成自官方指南(https://github.com/rust-lang/mdBook),references/ 目录包含完整未经修改的指南 Markdown,并每日更新。
用途 当用户询问 mdBook、mdbook、book.toml、SUMMARY.md、mdbook build、mdbook serve、mdbook init 等相关主题时使用。回答应基于下方参考文件中的官方 mdBook 文档。
参考文件覆盖的主题 入门:概览与简介(references/overview.md)、安装(cargo、二进制文件,references/installation.md)、创建新书(references/creating-a-book.md)、阅读与导航书籍(references/reading-books.md)。 CLI:所有 CLI 命令(init、build、watch、serve、test、clean、completions,references/cli.md)。 书籍格式:SUMMARY.md 结构与语法(references/summary-format.md)、Markdown 特性与扩展(references/markdown.md)、mdBook 特有功能(隐藏代码、include、playground,references/mdbook-specific.md)、MathJax 支持(references/mathjax.md)。 配置:book.toml(通用、预处理器、渲染器、环境变量,references/configuration.md)。 主题:主题定制(index.hbs、语法高亮、编辑器,references/theme.md)。 面向开发者:编写预处理器与后端(Rust API,references/for-developers.md)。 部署:CI/CD(GitHub Actions、GitLab CI,references/continuous-integration.md)。
使用方式 从用户问题中识别主题,然后读取上表中匹配的参考文件。配置示例应使用正确的 book.toml(TOML)语法,目录结构使用正确的 SUMMARY.md 格式。回答时需区分内置预处理器(links、index)与自定义预处理器,区分内置渲染器(HTML)与替代后端(pdf、epub 等)。当参考文件不足时,可从 raw GitHub 获取最新文档,地址格式为 https://raw.githubusercontent.com/rust-lang/mdBook/main/guide/src/<path>.md,例如 https://raw.githubusercontent.com/rust-lang/mdBook/main/guide/src/format/configuration/general.md、https://raw.githubusercontent.com/rust-lang/mdBook/main/guide/src/cli/build.md、https://raw.githubusercontent.com/rust-lang/mdBook/main/guide/src/format/theme/syntax-highlighting.md。
快速参考 创建新书:mdbook init my-book,进入目录后执行 mdbook serve --open,可在 http://localhost:3000 预览。 项目结构包含 book.toml(配置)、src/(SUMMARY.md 目录及章节文件)、book/(构建输出)。 SUMMARY.md 使用 Markdown 链接列表构建目录层级。 book.toml 可配置 [book] 标题、作者、语言、源码目录,[build] 构建目录,[output.html] 默认主题、暗色主题、Git 仓库地址等。 构建命令:mdbook build(构建到 book/)、mdbook serve(实时预览服务器)、mdbook watch(变更时重建)、mdbook test(测试 Rust 代码示例)、mdbook clean(删除构建产物)。
限制 该资料为 mdBook 官方文档的参考技能,未提供收费、价格、平台支持范围等信息。