Jupyter Book 使用教程

Jupyter Book 使用教程

项目地址:https://gitcode.com/gh_mirrors/ju/jupyter-book

1. 项目介绍

Jupyter Book 是一个开源工具，用于构建出版质量的书籍和文档，其特色在于从计算内容中创建交互式和印刷版的高质量材料。它支持Markdown文件和Jupyter笔记本，允许嵌入计算元素（如代码单元格），并提供诸如引用、交叉引用和编号公式等丰富语法。通过简单的命令，可以运行嵌入的代码单元格、缓存输出并转换成网页互动图书或PDF出版物。

2. 项目快速启动

首先确保已安装了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格式准备打印。

3. 应用案例和最佳实践

示例1：创建交互式教材

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

最佳实践

1. 保持文件组织：将相关章节放在单独的文件夹中，便于管理和更新。
2. 利用预处理器：例如，使用execute_notebooks预处理器自动运行所有代码单元格以更新结果。
3. 版本控制：使用Git进行版本管理，以便跟踪图书的更改和协作编辑。

4. 典型生态项目

• Sphinx：用于生成文档的强大工具，Jupyter Book与其集成提供了更丰富的文档功能。
• MyST Markdown：一种Markdown扩展，允许在文档中嵌入Sphinx指令和Jupyter笔记本。
• Binder：通过URL分享交互式书籍，使读者可以直接在线运行代码。
• Read the Docs：托管服务，可自动化构建、版本控制和发布技术文档，包括Jupyter Book。

以上是Jupyter Book的基本指南和一些实用技巧。探索更多可能性，为你的计算工作流添加交互性和专业性。祝你好运！

jupyter-book Create beautiful, publication-quality books and documents from computational content. 项目地址: https://gitcode.com/gh_mirrors/ju/jupyter-book