1. 简介
mdbook是一个用于编写和生成在线书籍的命令行工具，它允许使用Markdown格式编写电子书以及任何其他文档。使用者可以在本机或者私人服务器上生成最终的HTML效果渲染。
2. 安装mdbook
确保您已经安装了Rust和Cargo。
使用以下命令安装 mdbook
cargo install mdbook
您可以使用 mdbook --version来检查mdbook是否已经安装成功。
3. 创建mdbook
运行以下命令以创建一个新的mdbook
mdbook init mybook
这将在当前目录中创建一个名为mybook的文件夹，并在其中创建一个名为src的文件夹。src文件夹是您将编写内容的主要区域。
在src目录中编写book.toml文件以配置项目的元数据和工程信息，文件大概长这样：
------ ----- - --- ----- ------ - ----- -----
4. 编写mdbook
在src目录中，您可以创建一个名为SUMMARY.md的文件。SUMMARY.md是电子书的目录，其中描述了每个章节的摘要。在文件中添加以下内容：
- ------- - ----------------------------------- - -------- -------------------------- - -------- -------------------------- - -------- --------------------------
SUMMARY.md仅仅是放置书籍章节的地方，无须确定是按顺序还是按照逻辑顺序写的哦。
在chapters目录下，您可以编写每章的md文件。示例如下：
- ------- - -------------------------
每个章节都需要在Summary.md文件中的列表中列出。
5. 构建mdbook
编写完i初始mdbook的内容之后，您可以使用以下命令生成HTML：
------ -----
这将在.mdbook目录中生成一个book文件夹。访问book文件夹中的index.html文件会打开书籍的电子书版本。
-- ----- ---- ----------
6. 发布mdbook
如果您想将mdbook发布到公共服务器上，可以使用以下命令构建最终版本:
------ ----- ---------------------------
使用此命令将生成HTML版本并将其复制到指定目录中。您可以通过SFTP或其他方式将其上传到服务器上，并在其中创建HTML版书站点。
7. 结束语
mdbook 可以帮助您制作出漂亮、易读、可维护的在线文档，简单易上手。如果您想要在自己的项目中使用自定义样式，请参考官方文档。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005581e81e8991b448d54a1