Jupyter bookでビルド時にコードを実行する方法

JupyterBookを用いてGithub-Pagesでウェブサイトを公開する際に、Markdownファイルに記述したコードを実行し結果も表示するようにする方法を紹介します。

Jupytextをpipする

pip install jupytext

でjupytextをインストールしましょう．

MarkdownファイルをMyst Markdownファイルに変換する

Jupyter BookにはMarkdownファイルを MystMarkdownファイルに変換する機能が備わっています。
以下のkernelnameをpython3 または julia-1.8に置き換えて以下のコードを実行することでkernel言語で書かれたコードを実行できるようにします。

jupyter-book myst init 変換するMarkdownファイル.md --kernel kernelname

これを実行すると、mdファイルの上部に

jupytext:
cell_metadata_filter: -all
formats: md:myst
text_representation:
extension: .md
format_name: myst
format_version: 0.13
jupytext_version: 1.14.5
kernelspec:
display_name: Python 3 (ipykernel)
language: python
name: python3

といったものが追加されます(上はpythonの場合)

実行したいコードを{code-cell}内に書く

Markdownファイルに実行したいコードを書きます。その際、

とすることでJupyterBookのbuild時に勝手に実行してくれるようになります。

以下は自分のサイトですが、実例です。

以上です。