The init command 初始化命令

每本新书都有共性的样板,因此 mdbook 提供了 init 命令

init 像下面这样:

mdbook init

首次使用init命令时,将自动生成设置几个文件和文件夹

book-test/
├── book
└── src
    ├── chapter_1.md
    └── SUMMARY.md
  • src目录是你用markdown写书的地方。它包含所有源文件,配置文件等。
  • book目录是图书的生成呈现位置。所有输出内容可以 上传到服务器,供您的读者阅读。
  • SUMMARY.md 规划您图书的结构,并更详细地讨论在另一 章.

提示:从 SUMMARY.md 生成章节

SUMMARY.md 文件已存在时,init 命令将首先解析它 并根据SUMMARY.md中使用的路径生成丢失或者不存在的文件。 这使您可以思考并创建书籍的整个结构,然后 让 mdBook 为您生成它。

指定目录

init命令可以将目录作为参数,以用作书籍的根目录 而不是当前的工作目录。

mdbook init path/to/book

--theme

当您使用--theme 参数时,默认主题将被复制到 源目录中名为theme的目录,以便您可以对其进行修改。

主题被选择性地覆盖,这意味着如果你不想 覆盖特定文件,只需将其删除,即可使用默认文件。

--title

指定图书的标题。如果未提供,交互式提示将要求输入 标题。

mdbook init --title="my amazing book"

--ignore

创建一个“.gitignore”文件,该文件配置为忽略building书籍时创建的“书籍”目录。 如果未提供,将出现一个交互式提示,询问是否应创建它。