• In Markdown cells, use the $$, $$ $$ environments for equations.
• References are listed in the markdown cell at the bottom of each notebook.

pip3 install jupyter-book ghp-import jupytext

1. Write a jupyter notebook. Your notebook must be placed under the src directory with a name *_py.ipynb (python) or *_jl.ipyb (julia).

2. Convert the notebook to a MyST markdown file.

jupytext --to md:myst notebook_py.ipynb

1. Make html files

The following command builds html files.

make build

1. Convert a MyST markdown file to a notebook:

jupytext --to ipynb notebook_py.md

1. Update the notebook using jupyter notebook/lab

2. Convert the notebook file to a Markdown file:

jupytext --to md:myst notebook_py.ipynb

Before commiting a new MyST Markdown file, update the header of all Markdown files:

make update_header

Then, you will be ready to commit updated files.

make upload

We recommend to use VSCode + Docker to build HTML files.

1. Make sure you have Docker and VSCode installed.

2. Install the Remote - Containers in VSCode Extensions.

3. Go to the repository and open it in VS Code.

cd /path/to/this/repository

code .

1. To use Docker with VS Code, execute the following command.

ln -s .dev/devcontainer .devcontainer

1. Press the green mark at the bottom left and press Reopen in Container from the command palette. After the build is finished, you can enter the Docker container.

You can add references to references.bib.

• jupyter-book/jupyter-book#1541