MDBook简介
MDBook 是一个灵感来自 Gitbook 的强大工具,专门用于创建电子书和文档。
它能够将 Markdown 编写的内容编译成静态网站,非常适合项目文档、教程和书籍的发布。
安装与配置
安装 MDBook:
cargo install mdbook
初始化项目
创建一个新的 MDBook 项目,执行以下命令:
mdbook init my-book
这样将会创建一个名为 my-book 的新目录,其中包含项目的配置文件和目录结构:
my-book
├── book
├── book.toml
└── src
├── chapter_1.md
└── SUMMARY.md
文件结构
book.toml 是 MDBook 的配置文件,用于定义书籍的标题、作者及其他配置选项。示例如下:
[book]
authors = ["rexwzh"]
language = "en"
multilingual = false
src = "src"
title = "MDBook demo"
[output.html]
theme = "light"
构建和预览
在完成文档内容的编写和调整后,进入项目根目录,运行以下命令进行构建:
mdbook build
这将在 book 目录下生成静态网页,可以通过 -d 参数指定输出目录。
为了更便捷地预览文档,可以启动本地服务器进行交互式查看:
mdbook serve
默认服务器在 localhost:3000
上启动。也可以通过以下命令指定不同的参数:
mdbook serve -p 8080 -n 0.0.0.0 -d book