Jupyter Book 使用教程

10.1. Jupyter Book 使用教程#

首先确保已安装了Python环境，然后使用 pip 安装Jupyter Book：

!pip install jupyter-book

创建一个新的Jupyter Book项目：

jb new mybook

这将在当前目录下创建一个名为mybook的文件夹，里面包含基本的Jupyter Book结构。 接着进入项目目录并构建图书：

cd mybook
jb build .

现在，你的图书已经在_build/html目录下以HTML形式准备好查看，或者在_build/latex中以PDF格式准备打印。

总的来说，写一本 jupyter book 分三步

  1. Create your book's content.在本地一个文件夹中，准备好书的内容文件（markdowns，jupyter notebooks，图片）和配置文件（_config.yml 和 _toc.yml）

  2. Build your book.使用 Jupyter Book 命令将第一步的内容文件按指定配置转化为 HTML 文件，这样就可以在本地预览啦

  3. Publish your book online.使用 Jupyter Book 命令将书发布到网上，一般是发布到 https://<user>.github.io/<myonlinebook>/

10.1.1. 应用案例和最佳实践#

示例1：创建交互式教材

利用Jupyter Book，教育工作者可以创建包含可执行代码和实时结果的数学或编程教材。 学生可以在阅读时直接修改和运行代码，加深理解。

最佳实践

  • 保持文件组织：将相关章节放在单独的文件夹中，便于管理和更新。

  • 利用预处理器：例如，使用execute_notebooks预处理器自动运行所有代码单元格以更新结果。

  • 版本控制：使用Git进行版本管理，以便跟踪图书的更改和协作编辑。

典型生态项目

  • Sphinx：用于生成文档的强大工具，Jupyter Book与其集成提供了更丰富的文档功能。

  • MyST Markdown：一种Markdown扩展，允许在文档中嵌入Sphinx指令和Jupyter笔记本。

  • Binder：通过URL分享交互式书籍，使读者可以直接在线运行代码。

  • Read the Docs：托管服务，可自动化构建、版本控制和发布技术文档，包括Jupyter Book。

目录