通过mdBook制作图书

一旦您已经安装了mdbook命令行工具,那么您可以使用它创建或渲染您的图书

初始化开始制作图书

mdbook init 命令将创建一个包含空书的新目录,供您开始使用。my-first-book是为其指定要创建的目录的名称:

mdbook init my-first-book

在生成书籍之前,它会问几个问题.回答完问题后,初始化完成。您可以进入新生成的目录:

cd my-first-book

有几种方法可以渲染一本书,但最简单的方法之一是使用“serve”命令,这将自动构建你的书并启动本地Web服务器:

mdbook serve --open

--open 选项将打开默认的 Web 浏览器以查看新图书。即使在编辑书籍内容时,您也可以让服务器保持运行状态,mdbook将自动重建输出并自动刷新Web浏览器。

查看 CLI Guide 可以获取更多的mdbook 命令和CLI 选项

mdbook 图书构建细节

mdbook制作的图书是由几个文件构建的,这些文件定义了书的设置和布局。

book.toml

在您的创建图书的根目录下,有一个 book.toml 文件,这个文件用来表述如何构建书籍的设置。这是用TOML标记语言编写的。 默认设置通常足以让你入门。 当您有兴趣探索 mdBook 提供的更多功能和选项时,请查看 配置章节 了解更多详情。

一个非常简单的 book.toml 像下面的例子:

[book]
title = "My First Book"

SUMMARY.md

另外一个主要部分是位于 src/SUMMARY.md 的摘要文件。此文件包含本书中所有章节的列表。必须先将某一章添加到此列表中,然后才能查看该章。

下面是一个包含几个章节的基本摘要文件示例:

# Summary

[Introduction](README.md)

- [My First Chapter](my-first-chapter.md)
- [Nested example](nested/README.md)
    - [Sub-chapter](nested/sub-chapter.md)

可以尝试用在你的编辑器中打开 src/SUMMARY.md 并添加一些章节。如果任何章节文件不存在,mdbook将自动为您创建它们。

有关摘要文件的其他格式设置选项的更多详细信息,请查看 SUMMARY.md 章节.

源文件

您的图书内容都包含在src目录中。 每个章节都是一个单独的 Markdown 文件。 通常,每章都以 H1 级标题和章节标题开头。

# My First Chapter

Fill out your content here.

文件的精确布局取决于您。文件的组织将与生成的 HTML 文件相对应,因此请记住,文件布局是每个章节 URL 的一部分。

当 mdbook serve 命令正在运行时,您可以打开任何章节文件并开始编辑它们。每次保存文件时,mdbook都会重建书籍并刷新您的Web浏览器。

查看 Markdown chapter 章节,了解有关设置章节内容格式的更多信息。

src 目录中的所有其他文件都将包含在输出中。因此,如果您有图像或其他静态文件,只需将它们包含在src目录中的某个位置即可。

发布图书

一旦您写完书后,您可能希望将其托管在某个地方供其他人查看。 第一步是建立这本书的输出。 这可以通过book.toml文件所在的同一目录中的mdbook build命令来完成:

mdbook build

这将生成一个名为book的目录,其中包含您图书的全部HTML内容。 然后,您可以将此目录book 里面的内容放在任何 Web 服务器上以托管它。

有关发布和部署的详细信息,请查看持续集成章节 了解更多信息。