From 3dd6f551f9c9bcf5a73a05a071b532f539cbedbd Mon Sep 17 00:00:00 2001 From: Adrian Vollmer Date: Mon, 3 Jul 2023 19:37:54 +0200 Subject: [PATCH] Clarify README about building jupyter-books Close #3 --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 25bec07..a5c5bc7 100644 --- a/README.md +++ b/README.md @@ -84,8 +84,24 @@ builder. The builder is a thin wrapper around the HTML builder, which runs there is a suitable Makefile, with `make zundler`. Jupyter-Books can be built with `jupyter-book build --custom-builder -zundler`. You may have to add a render priority for Zundler like -[here](https://jupyterbook.org/en/stable/content/code-outputs.html#render-priority). +zundler --builder custom .`. You may have to add a render priority for Zundler like +[here](https://jupyterbook.org/en/stable/content/code-outputs.html#render-priority): + +```yaml +sphinx: + config: + nb_mime_priority_overrides: [ + ["zundler", "application/vnd.jupyter.widget-view+json", 10], + ["zundler", "application/javascript", 20], + ["zundler", "text/html", 30], + ["zundler", "image/svg+xml", 40], + ["zundler", "image/png", 50], + ["zundler", "image/jpeg", 60], + ["zundler", "text/markdown", 70], + ["zundler", "text/latex", 80], + ["zundler", "text/plain", 90] + ] +``` Demos -----