mdBook 开源笔记

mdBook 是一个用于从 Markdown 文件创建现代在线书籍的命令行工具。它是 Rust 官方文档（如《Rust 程序设计语言》）的构建工具。

bash 复制代码

cargo install mdbook

bash 复制代码

# macOS (Homebrew)
brew install mdbook

# Ubuntu (Snap)
sudo snap install mdbook

# Arch Linux (Pacman)
sudo pacman -S mdbook

bash 复制代码

mdbook init my-book
cd my-book

bash 复制代码

my-book/
├── book/          # 构建输出目录
├── src/           # 源文件目录
│   ├── SUMMARY.md # 书籍大纲
│   └── chapter_1.md
└── book.toml      # 配置文件

bash 复制代码

# 构建书籍
mdbook build

# 启动实时预览服务器
mdbook serve

# 在构建前清理旧文件
mdbook clean

# 测试代码示例
mdbook test

toml 复制代码

[book]
title = "我的书籍"
authors = ["作者名"]
description = "书籍描述"

[build]
build-dir = "book"
create-missing = true

toml 复制代码

[output.html]
mathjax-support = true

[preprocessor.links]
command = "mdbook-linkcheck"

bash 复制代码

cargo install mdbook-linkcheck

然后在 book.toml 中配置：

toml 复制代码

[preprocessor.linkcheck]
command = "mdbook-linkcheck"

markdown 复制代码

✅ 开源项目文档
✅ 技术教程和课程教材
✅ 团队知识库和规范文档
✅ 个人作品集和技术博客

markdown 复制代码

❌ 零散的个人笔记管理
❌ 需要富文本编辑器的用户
❌ 实时协作编辑需求