用途:MD-Book 是一个基于 Rust 的文档生成器技能,把 Markdown 文件转换为 HTML 文档,定位为 mdbook 的现代替代品。
主要能力:支持 Markdown、GFM、MDX 等多种格式;通过 syntect 提供服务端语法高亮;内置开发服务器与文件监听、WebSocket 自动刷新;集成 Pagefind 全文搜索;每个页面带右侧页内目录;支持 Tera 模板自定义;内置 doc-toc、search-modal、doc-sidebar、simple-block 等 Web Components。首页有两种方式:存在 index.md 时以其内容作为自定义首页,否则自动生成基于 Shoelace 卡片的导航页。
使用方式:基本构建为 md-book -i input_dir -o output_dir;开发模式加 --watch,内置服务器用 --serve(默认端口 3000),完整开发模式为 md-book -i input_dir -o output_dir --watch --serve --port 8080。参数包括 -i/--input、-o/--output、-c/--config、-w/--watch、-s/--serve、--port。配置优先级从高到低为:CLI 参数、环境变量(MDBOOK_ 前缀,如 MDBOOK_BOOK.TITLE)、--config 指定的配置文件、当前目录 book.toml、默认值。可从源码运行:git clone https://github.com/terraphim/md-book.git,cargo build --release。搜索需先 cargo install pagefind,构建时自动生成索引。
适用场景与限制:适合从 Markdown 生成可搜索的静态文档站点,可部署到 Cloudflare Pages、Netlify、GitHub Pages、Vercel 等平台。安全方面,Markdown 内原始 HTML 默认禁用,allow-html = true 会带来 XSS 风险,仅在信任全部内容作者时启用。资料未提供具体收费、价格或许可信息。