自动创建书籍

本节介绍如何自动创建书籍，以便更快地开始使用。

从简单模板创建书籍

Jupyter Book 允许您从模板快速生成书籍结构。 本节介绍创建模板书籍并将其构建为替代手动创建书籍文件的过程。

要查看从模板创建书籍的选项，请运行以下命令：

jupyter-book create --help

Usage: jupyter-book create [OPTIONS] PATH_BOOK

  Create a Jupyter Book template that you can customize.

Options:
  --cookiecutter  Use cookiecutter to interactively create a Jupyter Book
                  template.
  --no-input      If using cookiecutter, do not prompt the user for input.
  -h, --help      Show this message and exit.

如果您是从头开始，或者想在本地文件系统上查看一个简单的 Jupyter Book 示例，此选项是最佳选择。

如果您只想快速创建一个示例书籍，可以运行以下命令：

jupyter-book create mynewbook/

这将生成一个迷你 Jupyter Book，您可以在本地构建和探索。它将为您做出一些决策，您可以在 _config.yml 中探索书籍的配置，在 _toc.yml 中探索其结构。将此书籍用作灵感，或作为工作的起点。

通过交互式提示创建更完整的书籍

如果您想通过回答命令行中的一些问题来创建一个更复杂且为您的用例定制的模板书籍，此选项是最佳选择。

Jupyter Book 还提供了一个 Jupyter Book cookiecutter，可用于交互式创建书籍目录结构。

cookiecutter 是一个 Python 工具，用于从模板化仓库快速生成文件夹。Jupyter Book 在幕后使用 cookiecutter。

cookiecutter 适合那些希望创建一个包含预填充元文件（如 README、LICENSE、CONDUCT、CONTRIBUTING 等）以及 GitHub Actions 工作流文件（用于发布到 GitHub Pages）的现成仓库来托管他们的书籍的用户。

要尝试 cookiecutter 模板，请运行以下命令：

jupyter-book create mynewbook/ --cookiecutter

如需更多帮助，请参阅 Jupyter Book cookiecutter GitHub 仓库，或运行：

从目录创建书籍文件

可以使用 _toc.yml 文件来自动创建书籍的骨架。 如果您希望从单一结构快速生成空文件，然后自行填充内容，这将非常有用。

要从目录创建书籍文件，请使用以下命令：

jupyter-book toc to-project path/to/_toc.yml

这将根据 _toc.yml 中的结构生成一系列文件。

此外，您有几个选项可以控制此工具的行为。 参考以下内容。

Usage: jupyter-book toc to-project [OPTIONS] TOC_FILE

  Create a project directory from a ToC file.

Options:
  -p, --path DIRECTORY      The root directory [default: ToC file directory].
  -e, --extension [rst|md]  The default file extension to use.  [default: rst]
  -o, --overwrite           Overwrite existing files.
  -h, --help                Show this message and exit.