JupyterBookΒΆ
π¦ Installation & Setup
Install
pip install "jupyter-book<2"Create a new book
jb create mybookBuild
jb build mybookπ Project Structure
mybook/
_config.yml
_toc.yml
intro.md
chapter-1/
index.mdπ Content Types
Markdown pages
intro.md
chapter-1/section.mdNotebooks
notebooks/example.ipynbMyST directives
```{admonition} Title
:class: tip
Content
```π§ _config.yml Reference
title: My Book
author: Your Name
logo: _static/logo.png
execute:
execute_notebooks: auto
repository:
url: https://github.com/user/repo
html:
use_repository_button: trueποΈ _toc.yml Reference
format: jb-book
root: intro
chapters:
- file: chapter-1/index
sections:
- file: chapter-1/sectionποΈ Building & Previewing
jb build mybook
jb build mybook --all
python -m http.server -d mybook/_build/html 8000π Deployment (GitHub Pages)
jb build mybook
ghp-import -n -p -f mybook/_build/html