概述

这是构建 Jupyter Book 的主要组件和步骤的简要概述。有关更深入的信息，请参阅本指南中的其他页面。

安装 Jupyter Book

您可以通过 pip 安装 Jupyter Book：

pip install -U jupyter-book

或者通过 conda-forge：

conda install -c conda-forge jupyter-book

这将安装在本地构建 Jupyter Book 所需的所有内容。

请注意，如果您需要在构建书籍时执行代码，您还需要安装这些依赖项。

Jupyter Book 命令行界面

Jupyter Book 使用命令行界面执行各种操作。例如，构建和清理书籍。您可以运行以下命令来查看您可以控制哪些选项：

您也可以使用简写 jb 代替 jupyter-book。例如：jb create mybookname。在本指南的其余部分，我们将使用 jupyter-book。

jupyter-book --help

Usage: jupyter-book [OPTIONS] COMMAND [ARGS]...

  Build and manage books with Jupyter.

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  build   Convert your book's or page's content to HTML or a PDF.
  clean   Empty the _build directory except jupyter_cache.
  config  Inspect your _config.yml file.
  create  Create a Jupyter Book template that you can customize.
  myst    Manipulate MyST markdown files.
  toc     Command-line for sphinx-external-toc.

有关 CLI 的更完整信息，请参见 命令行界面参考。

书籍构建过程

构建 Jupyter Book 大致包括以下步骤：

1. 创建您的书籍内容。您可以使用一系列文件夹、文件和配置来组织您的书籍。参见 Jupyter Book 的结构。

2. 构建您的书籍。使用 Jupyter Book 的命令行界面，您可以将页面转换为 HTML 或 PDF 书籍。参见 构建你的书籍。

3. 在线发布您的书籍。一旦您的书籍构建完成，您可以与他人分享。最常见的是构建 HTML，并将其作为公共网站托管。参见 在线发布你的书籍。

Note

我们将使用“书籍”一词来描述本教程生成的输出，但您也可以使用 Jupyter Book 构建文章。有关更多信息，请参见 文章结构。

现在我们已经有了一个简要概述，让我们开始构建您的第一本书。