JupyterBook 是一个用于构建基于 Jupyter Notebook 的文档和教材的工具,它允许你将 Notebook 和 Markdown 文件结合起来,创建交互式的在线书籍和教程。这里是一些基本操作,帮助你快速上手 JupyterBook。
1. 安装 JupyterBook
-
通过
pip
安装:pip install jupyter-book
2. 创建 JupyterBook 项目
-
创建一个新的 JupyterBook 项目: 在命令行中运行以下命令:
jupyter-book create mybook
这会生成一个名为
mybook
的文件夹,其中包含一些示例文件和目录结构。
3. 项目结构
创建的 JupyterBook 项目通常包括以下目录和文件:
mybook/
:根目录_config.yml
:配置文件,包含书籍的全局设置。_build/
:构建输出目录。_static/
:静态文件(如图片、CSS 文件等)。content/
:包含实际内容的目录。index.md
:书籍的首页。notebooks/
:存放 Jupyter Notebook 文件。chapters/
:存放章节内容的目录。
4. 添加内容
-
编辑书籍的内容: 你可以通过 Markdown (
.md
) 文件和 Jupyter Notebook (.ipynb
) 文件来添加内容。Markdown 文件用于写文本,而 Notebook 文件可以包含代码、输出结果、图表等。 -
添加章节: 在
content/chapters/
目录下,可以创建新的章节文件,如:touch content/chapters/chapter1.md
然后在
chapter1.md
文件中编写你的章节内容。 -
添加 Notebook: 在
content/notebooks/
目录下,存放 Jupyter Notebook 文件,如:jupyter-notebook content/notebooks
5. 配置文件 _config.yml
-
设置书籍的元数据: 打开
_config.yml
文件,可以修改书籍的标题、作者等信息。例如:title: "我的第一本书" author: "你的名字"
-
添加导航栏: 你可以在
_config.yml
中配置书籍的导航栏,定义各章节和 Notebook 文件的顺序:nav: - Home: index.md - Chapter 1: chapters/chapter1.md - Notebook 1: notebooks/notebook1.ipynb
6. 构建和查看书籍
-
构建书籍: 在命令行中运行以下命令来构建书籍:
jupyter-book build mybook
这会将书籍构建为 HTML 格式,并将其输出到
_build/html
目录中。 -
查看书籍: 在浏览器中打开构建出来的书籍:
jupyter-book serve mybook
然后在浏览器中打开
http://localhost:8000
,就可以看到你的书籍了。
7. 发布书籍
-
将书籍发布到 GitHub: JupyterBook 支持直接将书籍发布到 GitHub Pages。你可以使用以下命令将书籍发布到 GitHub 上:
jupyter-book gh-pages mybook
这会将生成的 HTML 文件推送到 GitHub 并自动创建一个 GitHub Pages 页面。
8. 常用命令总结
-
创建书籍:
jupyter-book create mybook
-
构建书籍:
jupyter-book build mybook
-
查看书籍:
jupyter-book serve mybook
-
发布书籍:
jupyter-book gh-pages mybook
9. 扩展功能
-
运行 Notebook 代码:JupyterBook 会自动执行你书中的 Notebook 代码,确保所有的输出结果是最新的。
-
插入 LaTeX:支持在 Markdown 文件中使用 LaTeX 公式,像这样:
$$ E = mc^2 $$
10. 推荐学习资源
通过这些步骤,可以顺利创建并发布一个基于 Jupyter Notebook 的交互式书籍。