Jupyter Book 概述#

Note

Jupyter Book is an open-source tool for building publication-quality books and documents from markdown files and Jupyter notebooks.

官网 https://jupyterbook.org/en/stable/intro.html

安装 Jupyter Book#

通过 pip 安装:

pip install -U jupyter-book

通过 conda 安装:

conda install -c conda-forge jupyter-book

步骤#

总的来说,写一本 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>/