1<!DOCTYPE html><html lang="en" class="" style="scroll-padding:60px"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1"/><link rel="preload" as="image" href="/stable/build/config-item-65699539-b044d4fe0e87b77862847c69bbb05174.svg"/><link rel="preload" as="image" href="/stable/build/config-item-938b93dc-bfab6677293c5780ea12da96a5b66e8a.svg"/><title>Jupyter Book User Guide - Jupyter Book User Guide</title><meta property="og:title" content="Jupyter Book User Guide - Jupyter Book User Guide"/><meta name="generator" content="mystmd"/><meta name="keywords" content=""/><link rel="icon" href="/stable/favicon.ico"/><link rel="modulepreload" href="/stable/build/entry.client-NNNALS5X.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-UBXX7P26.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-KB7LMXDF.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-RAQ24GF6.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-LS4ALTVG.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-7FWBVTMU.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-7YIJOVKB.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-MCEKF3CD.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-BVQ4IR5U.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-EVF4GZYD.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-6LPWM5X2.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-WNVPCTL5.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-IZ3HLG6T.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-TBCV2LPN.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-SWBLOF4V.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-J56WUMNK.js"/><link rel="modulepreload" href="/stable/build/root-C5CK33H3.js"/><link rel="modulepreload" href="/stable/build/_shared/chunk-WGW5MSUV.js"/><link rel="modulepreload" href="/stable/build/routes/$-6ALOT4PW.js"/><link rel="stylesheet" href="/stable/build/_assets/app-XNK7MHNS.css"/><link rel="stylesheet" href="/stable/build/_assets/thebe-core-VKVHG5VY.css"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/css/mpl_widget.css"/><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.css"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ" crossorigin="anonymous"/><link rel="stylesheet" href="/stable/myst-theme.css"/>
1<script> 2 const savedTheme = localStorage.getItem("myst:theme"); 3 const theme = window.matchMedia("(prefers-color-scheme: light)").matches ? 'light' : 'dark'; 4 const classes = document.documentElement.classList; 5 const hasAnyTheme = classes.contains('light') || classes.contains('dark'); 6 if (!hasAnyTheme) classes.add(savedTheme ?? theme); 7</script>
7<script>(function(){var p=window.location.pathname;if(p.endsWith('/index.html'))window.location.replace((p.slice(0,-10)||'/')+window.location.search+window.location.hash);})();</script>
7<script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script>
7<meta name="readthedocs-project-slug" content="jupyter-book" /><meta name="readthedocs-version-slug" content="stable" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head><body class="m-0 bg-myst-bg"><div class="myst-skip-to-article fixed top-1 left-1 h-[0px] w-[0px] focus-within:z-40 focus-within:h-auto focus-within:w-auto bg-myst-bg overflow-hidden focus-within:p-2 focus-within:ring-1" aria-label="skip to content options"><a href="#skip-to-frontmatter" class="myst-skip-to-link block px-2 py-1 text-myst-text underline">Skip to article frontmatter</a><a href="#skip-to-article" class="myst-skip-to-link block px-2 py-1 text-myst-text underline">Skip to article content</a></div><dialog id="myst-no-css" style="position:fixed;left:0px;top:0px;width:100%;height:100vh;font-size:4rem;padding:1rem;color:black;background:white"><strong>Site not loading correctly?</strong><p>This may be due to an incorrect <code>BASE_URL</code> configuration. See<!-- --> <a href="https://mystmd.org/guide/deployment#deploy-base-url">the MyST Documentation</a> <!-- -->for reference.</p>
7<script> 8 (() => { 9 // Test for has-styling variable set by the MyST stylesheet 10 const node = document.currentScript.parentNode; 11 const hasCSS = window.getComputedStyle(node).getPropertyValue("--has-styling"); 12 if (hasCSS === ""){ 13 node.showModal(); 14 } 15 16 })() 17</script>
17</dialog><div class="myst-top-nav myst-bg-translucent backdrop-blur shadow dark:shadow-2xl p-3 md:px-8 sticky w-full top-0 z-30 min-h-[60px]"><nav class="myst-top-nav-bar flex items-center justify-between flex-nowrap max-w-[1440px] mx-auto"><div class="flex flex-row xl:min-w-[19.5rem] mr-2 sm:mr-7 justify-start items-center shrink-0"><div class="block xl:hidden"><button class="myst-top-nav-menu-button flex items-center justify-center border-myst-border-strong text-myst-text-secondary hover:text-myst-text w-10 h-10"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" width="1.5rem" height="1.5rem"><path fill-rule="evenodd" d="M3 6.75A.75.75 0 0 1 3.75 6h16.5a.75.75 0 0 1 0 1.5H3.75A.75.75 0 0 1 3 6.75ZM3 12a.75.75 0 0 1 .75-.75h16.5a.75.75 0 0 1 0 1.5H3.75A.75.75 0 0 1 3 12Zm0 5.25a.75.75 0 0 1 .75-.75h16.5a.75.75 0 0 1 0 1.5H3.75a.75.75 0 0 1-.75-.75Z" clip-rule="evenodd"></path></svg><span class="sr-only">Open Menu</span></button></div><a class="myst-home-link flex items-center ml-3 text-myst-text w-fit md:ml-5 xl:ml-7" href="/"><div class="myst-home-link-logo mr-3 flex items-center"><img src="/stable/build/config-item-65699539-b044d4fe0e87b77862847c69bbb05174.svg" class="h-9 dark:hidden" height="2.25rem"/><img src="/stable/build/config-item-938b93dc-bfab6677293c5780ea12da96a5b66e8a.svg" class="hidden h-9 dark:block" height="2.25rem"/></div><span class="text-md sm:text-xl tracking-tight sm:mr-5 sr-only">Made with MyST</span></a></div><div class="flex items-center flex-grow w-auto"><div class="flex-grow hidden text-md lg:block"><div class="myst-top-nav-item relative inline-block mx-2 grow-0"><a class="inline-flex items-center justify-center w-full mx-2 py-1 text-md font-medium text-myst-text hover:text-myst-active focus:outline-none focus-visible:ring-2 focus-visible:ring-myst-focus-ring focus-visible:ring-opacity-75" href="https://jupyterbook.org/stable">Docs</a></div><div class="myst-top-nav-item relative inline-block mx-2 grow-0"><a class="inline-flex items-center justify-center w-full mx-2 py-1 text-md font-medium text-myst-text hover:text-myst-active focus:outline-none focus-visible:ring-2 focus-visible:ring-myst-focus-ring focus-visible:ring-opacity-75" href="https://jupyterbook.org/community">Community</a></div><div class="myst-top-nav-item relative inline-block mx-2 grow-0"><a class="inline-flex items-center justify-center w-full mx-2 py-1 text-md font-medium text-myst-text hover:text-myst-active focus:outline-none focus-visible:ring-2 focus-visible:ring-myst-focus-ring focus-visible:ring-opacity-75" href="https://jupyterbook.org/contribute">Contribute</a></div><div class="myst-top-nav-item relative inline-block mx-2 grow-0"><a class="inline-flex items-center justify-center w-full mx-2 py-1 text-md font-medium text-myst-text hover:text-myst-active focus:outline-none focus-visible:ring-2 focus-visible:ring-myst-focus-ring focus-visible:ring-opacity-75" href="https://jupyterbook.org/blog">Blog</a></div><div class="myst-top-nav-item relative inline-block mx-2 grow-0"><a class="inline-flex items-center justify-center w-full mx-2 py-1 text-md font-medium text-myst-text hover:text-myst-active focus:outline-none focus-visible:ring-2 focus-visible:ring-myst-focus-ring focus-visible:ring-opacity-75" href="https://jupyterbook.org/help">Help</a></div></div><div class="flex-grow block"></div><button type="button" aria-haspopup="dialog" aria-expanded="false" data-state="closed" class="myst-search-bar flex items-center h-10 aspect-square sm:w-64 text-left text-myst-text-secondary border border-myst-border-strong rounded-lg bg-myst-bg-secondary dark:bg-myst-surface-hover myst-search-bar-disabled hover:ring-myst-focus-ring hover:border-myst-focus-ring"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="p-2.5 h-10 w-10 aspect-square"><path fill-rule="evenodd" d="M10.5 3.75a6.75 6.75 0 1 0 0 13.5 6.75 6.75 0 0 0 0-13.5ZM2.25 10.5a8.25 8.25 0 1 1 14.59 5.28l4.69 4.69a.75.75 0 1 1-1.06 1.06l-4.69-4.69A8.25 8.25 0 0 1 2.25 10.5Z" clip-rule="evenodd"></path></svg><span class="myst-search-text-placeholder hidden sm:block grow">Search</span><div aria-hidden="true" class="myst-search-shortcut items-center hidden mx-1 font-mono text-sm text-myst-text-secondary sm:flex gap-x-1"><kbd class="px-2 py-1 border border-myst-border-strong rounded-md shadow-[0px_2px_0px_0px_rgba(0,0,0,0.08)] dark:shadow-none hide-mac">CTRL</kbd><kbd class="px-2 py-1 border border-myst-border-strong rounded-md shadow-[0px_2px_0px_0px_rgba(0,0,0,0.08)] dark:shadow-none show-mac">â</kbd><kbd class="px-2 py-1 border border-myst-border-strong rounded-md shadow-[0px_2px_0px_0px_rgba(0,0,0,0.08)] dark:shadow-none ">K</kbd>
17<script> 18;(() => { 19const script = document.currentScript; 20const root = script.parentElement; 21 22const isMac = /mac/i.test( 23 window.navigator.userAgentData?.platform ?? window.navigator.userAgent, 24 ); 25root.querySelectorAll(".hide-mac").forEach(node => {node.classList.add(isMac ? "hidden" : "block")}); 26root.querySelectorAll(".show-mac").forEach(node => {node.classList.add(!isMac ? "hidden" : "block")}); 27})()</script>
27</div></button><button class="myst-theme-button theme shrink-0 rounded-full border border-myst-border-strong hover:bg-myst-surface border-solid overflow-hidden text-myst-text-secondary w-8 h-8 ml-3" title="Toggle theme between light and dark mode" aria-label="Toggle theme between light and dark mode"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="myst-theme-moon-icon h-full w-full p-[18%] hidden dark:block"><path fill-rule="evenodd" d="M9.528 1.718a.75.75 0 0 1 .162.819A8.97 8.97 0 0 0 9 6a9 9 0 0 0 9 9 8.97 8.97 0 0 0 3.463-.69.75.75 0 0 1 .981.98 10.503 10.503 0 0 1-9.694 6.46c-5.799 0-10.5-4.7-10.5-10.5 0-4.368 2.667-8.112 6.46-9.694a.75.75 0 0 1 .818.162Z" clip-rule="evenodd"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="myst-theme-sun-icon h-full w-full p-[18%] dark:hidden"><path d="M12 2.25a.75.75 0 0 1 .75.75v2.25a.75.75 0 0 1-1.5 0V3a.75.75 0 0 1 .75-.75ZM7.5 12a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM18.894 6.166a.75.75 0 0 0-1.06-1.06l-1.591 1.59a.75.75 0 1 0 1.06 1.061l1.591-1.59ZM21.75 12a.75.75 0 0 1-.75.75h-2.25a.75.75 0 0 1 0-1.5H21a.75.75 0 0 1 .75.75ZM17.834 18.894a.75.75 0 0 0 1.06-1.06l-1.59-1.591a.75.75 0 1 0-1.061 1.06l1.59 1.591ZM12 18a.75.75 0 0 1 .75.75V21a.75.75 0 0 1-1.5 0v-2.25A.75.75 0 0 1 12 18ZM7.758 17.303a.75.75 0 0 0-1.061-1.06l-1.591 1.59a.75.75 0 0 0 1.06 1.061l1.591-1.59ZM6 12a.75.75 0 0 1-.75.75H3a.75.75 0 0 1 0-1.5h2.25A.75.75 0 0 1 6 12ZM6.697 7.757a.75.75 0 0 0 1.06-1.06l-1.59-1.591a.75.75 0 0 0-1.061 1.06l1.59 1.591Z"></path></svg></button><div class="block sm:hidden"></div><div class="hidden sm:block"></div></div></nav></div><div class="myst-primary-sidebar fixed xl:article-grid grid-gap xl:w-full xl:pointer-events-none overflow-auto max-xl:w-[75vw] max-xl:max-w-[350px] max-xl:!top-0 max-xl:h-screen hidden z-10" style="top:60px"><div class="myst-primary-sidebar-pointer pointer-events-auto xl:col-margin-left flex-col overflow-hidden max-xl:h-full hidden xl:flex"><div class="myst-primary-sidebar-nav flex-grow py-6 overflow-y-auto primary-scrollbar"><nav aria-label="Navigation" class="myst-primary-sidebar-topnav overflow-y-hidden transition-opacity lg:hidden ml-3 xl:ml-0 mr-3 max-w-[350px]"><div class="w-full px-1 text-myst-text font-medium"><a class="myst-primary-sidebar-item-short p-2 my-1 rounded-lg hover:bg-myst-surface block break-words focus:outline outline-myst-focus-outline outline-2 rounded" href="https://jupyterbook.org/stable">Docs</a><a class="myst-primary-sidebar-item-short p-2 my-1 rounded-lg hover:bg-myst-surface block break-words focus:outline outline-myst-focus-outline outline-2 rounded" href="https://jupyterbook.org/community">Community</a><a class="myst-primary-sidebar-item-short p-2 my-1 rounded-lg hover:bg-myst-surface block break-words focus:outline outline-myst-focus-outline outline-2 rounded" href="https://jupyterbook.org/contribute">Contribute</a><a class="myst-primary-sidebar-item-short p-2 my-1 rounded-lg hover:bg-myst-surface block break-words focus:outline outline-myst-focus-outline outline-2 rounded" href="https://jupyterbook.org/blog">Blog</a><a class="myst-primary-sidebar-item-short p-2 my-1 rounded-lg hover:bg-myst-surface block break-words focus:outline outline-myst-focus-outline outline-2 rounded" href="https://jupyterbook.org/help">Help</a></div></nav><div class="my-3 border-b-2 lg:hidden"></div><nav aria-label="Table of Contents" class="myst-primary-sidebar-toc flex-grow overflow-y-hidden transition-opacity ml-3 xl:ml-0 mr-3 max-w-[350px]"><div class="myst-toc w-full px-1 text-myst-text"><a title="Jupyter Book User Guide" class="block break-words focus:outline outline-myst-focus-outline outline-2 rounded myst-toc-item p-2 my-1 rounded-lg hover:bg-myst-surface font-bold" href="/stable/">Jupyter Book User Guide</a><div data-state="closed" class="w-full"><div class="myst-toc-item flex flex-row w-full gap-2 pl-2 my-1 text-left rounded-lg outline-none hover:bg-myst-surface"><a title="Get started" class="block break-words focus:outline outline-myst-focus-outline outline-2 rounded py-2 grow" href="/stable/get-started">Get started</a>
27<button class="self-stretch flex items-center flex-none px-1 rounded-l-md group hover:bg-myst-surface focus-visible:outline outline-myst-focus-outline outline-2" aria-label="Open Folder" type="button" aria-controls="radix-_R_18psp_" aria-expanded="false" data-state="closed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="transition-transform duration-300 group-data-[state=open]:rotate-90 text-myst-text-secondary" height="1.5rem" width="1.5rem"><path fill-rule="evenodd" d="M16.28 11.47a.75.75 0 0 1 0 1.06l-7.5 7.5a.75.75 0 0 1-1.06-1.06L14.69 12 7.72 5.03a.75.75 0 0 1 1.06-1.06l7.5 7.5Z" clip-rule="evenodd"></path></svg></button></div><div data-state="closed" id="radix-_R_18psp_" hidden="" class="pl-3 pr-[2px] collapsible-content" style="animation:none"></div></div><div data-state="closed" class="w-full"><div class="myst-toc-item flex flex-row w-full gap-2 pl-2 my-1 text-left rounded-lg outline-none hover:bg-myst-surface"><a title="Author Content" class="block break-words focus:outline outline-myst-focus-outline outline-2 rounded py-2 grow" href="/stable/authoring">Author Content</a>
27<button class="self-stretch flex items-center flex-none px-1 rounded-l-md group hover:bg-myst-surface focus-visible:outline outline-myst-focus-outline outline-2" aria-label="Open Folder" type="button" aria-controls="radix-_R_1opsp_" aria-expanded="false" data-state="closed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="transition-transform duration-300 group-data-[state=open]:rotate-90 text-myst-text-secondary" height="1.5rem" width="1.5rem"><path fill-rule="evenodd" d="M16.28 11.47a.75.75 0 0 1 0 1.06l-7.5 7.5a.75.75 0 0 1-1.06-1.06L14.69 12 7.72 5.03a.75.75 0 0 1 1.06-1.06l7.5 7.5Z" clip-rule="evenodd"></path></svg></button></div><div data-state="closed" id="radix-_R_1opsp_" hidden="" class="pl-3 pr-[2px] collapsible-content" style="animation:none"></div></div><div data-state="closed" class="w-full"><div class="myst-toc-item flex flex-row w-full gap-2 pl-2 my-1 text-left rounded-lg outline-none hover:bg-myst-surface"><a title="Build & Publish" class="block break-words focus:outline outline-myst-focus-outline outline-2 rounded py-2 grow" href="/stable/build-and-publish">Build & Publish</a>
27<button class="self-stretch flex items-center flex-none px-1 rounded-l-md group hover:bg-myst-surface focus-visible:outline outline-myst-focus-outline outline-2" aria-label="Open Folder" type="button" aria-controls="radix-_R_28psp_" aria-expanded="false" data-state="closed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="transition-transform duration-300 group-data-[state=open]:rotate-90 text-myst-text-secondary" height="1.5rem" width="1.5rem"><path fill-rule="evenodd" d="M16.28 11.47a.75.75 0 0 1 0 1.06l-7.5 7.5a.75.75 0 0 1-1.06-1.06L14.69 12 7.72 5.03a.75.75 0 0 1 1.06-1.06l7.5 7.5Z" clip-rule="evenodd"></path></svg></button></div><div data-state="closed" id="radix-_R_28psp_" hidden="" class="pl-3 pr-[2px] collapsible-content" style="animation:none"></div></div><div data-state="closed" class="w-full"><div class="myst-toc-item flex flex-row w-full gap-2 pl-2 my-1 text-left rounded-lg outline-none hover:bg-myst-surface"><a title="Execute & Compute" class="block break-words focus:outline outline-myst-focus-outline outline-2 rounded py-2 grow" href="/stable/execution">Execute & Compute</a>
27<button class="self-stretch flex items-center flex-none px-1 rounded-l-md group hover:bg-myst-surface focus-visible:outline outline-myst-focus-outline outline-2" aria-label="Open Folder" type="button" aria-controls="radix-_R_2opsp_" aria-expanded="false" data-state="closed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="transition-transform duration-300 group-data-[state=open]:rotate-90 text-myst-text-secondary" height="1.5rem" width="1.5rem"><path fill-rule="evenodd" d="M16.28 11.47a.75.75 0 0 1 0 1.06l-7.5 7.5a.75.75 0 0 1-1.06-1.06L14.69 12 7.72 5.03a.75.75 0 0 1 1.06-1.06l7.5 7.5Z" clip-rule="evenodd"></path></svg></button></div><div data-state="closed" id="radix-_R_2opsp_" hidden="" class="pl-3 pr-[2px] collapsible-content" style="animation:none"></div></div><div data-state="closed" class="w-full"><div class="myst-toc-item flex flex-row w-full gap-2 pl-2 my-1 text-left rounded-lg outline-none hover:bg-myst-surface"><a title="Extend with Plugins" class="block break-words focus:outline outline-myst-focus-outline outline-2 rounded py-2 grow" href="/stable/plugins">Extend with Plugins</a>
27<button class="self-stretch flex items-center flex-none px-1 rounded-l-md group hover:bg-myst-surface focus-visible:outline outline-myst-focus-outline outline-2" aria-label="Open Folder" type="button" aria-controls="radix-_R_38psp_" aria-expanded="false" data-state="closed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="transition-transform duration-300 group-data-[state=open]:rotate-90 text-myst-text-secondary" height="1.5rem" width="1.5rem"><path fill-rule="evenodd" d="M16.28 11.47a.75.75 0 0 1 0 1.06l-7.5 7.5a.75.75 0 0 1-1.06-1.06L14.69 12 7.72 5.03a.75.75 0 0 1 1.06-1.06l7.5 7.5Z" clip-rule="evenodd"></path></svg></button></div><div data-state="closed" id="radix-_R_38psp_" hidden="" class="pl-3 pr-[2px] collapsible-content" style="animation:none"></div></div><div data-state="closed" class="w-full"><div class="myst-toc-item flex flex-row w-full gap-2 pl-2 my-1 text-left rounded-lg outline-none hover:bg-myst-surface"><div title="Resources" class="block break-words rounded py-2 grow cursor-pointer">Resources</div>
27<button class="self-stretch flex items-center flex-none px-1 rounded-l-md group hover:bg-myst-surface focus-visible:outline outline-myst-focus-outline outline-2" aria-label="Open Folder" type="button" aria-controls="radix-_R_3opsp_" aria-expanded="false" data-state="closed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="transition-transform duration-300 group-data-[state=open]:rotate-90 text-myst-text-secondary" height="1.5rem" width="1.5rem"><path fill-rule="evenodd" d="M16.28 11.47a.75.75 0 0 1 0 1.06l-7.5 7.5a.75.75 0 0 1-1.06-1.06L14.69 12 7.72 5.03a.75.75 0 0 1 1.06-1.06l7.5 7.5Z" clip-rule="evenodd"></path></svg></button></div><div data-state="closed" id="radix-_R_3opsp_" hidden="" class="pl-3 pr-[2px] collapsible-content" style="animation:none"></div></div><div data-state="closed" class="w-full"><div class="myst-toc-item flex flex-row w-full gap-2 pl-2 my-1 text-left rounded-lg outline-none hover:bg-myst-surface"><div title="Contributor Guide" class="block break-words rounded py-2 grow cursor-pointer">Contributor Guide</div>
27<button class="self-stretch flex items-center flex-none px-1 rounded-l-md group hover:bg-myst-surface focus-visible:outline outline-myst-focus-outline outline-2" aria-label="Open Folder" type="button" aria-controls="radix-_R_48psp_" aria-expanded="false" data-state="closed"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="transition-transform duration-300 group-data-[state=open]:rotate-90 text-myst-text-secondary" height="1.5rem" width="1.5rem"><path fill-rule="evenodd" d="M16.28 11.47a.75.75 0 0 1 0 1.06l-7.5 7.5a.75.75 0 0 1-1.06-1.06L14.69 12 7.72 5.03a.75.75 0 0 1 1.06-1.06l7.5 7.5Z" clip-rule="evenodd"></path></svg></button></div><div data-state="closed" id="radix-_R_48psp_" hidden="" class="pl-3 pr-[2px] collapsible-content" style="animation:none"></div></div></div></nav></div><div class="myst-primary-sidebar-footer flex-none py-6 transition-all duration-700 translate-y-6 opacity-0 ml-3 xl:ml-0 mr-3 max-w-[350px]"><a class="myst-made-with-myst flex mx-auto text-myst-text-secondary w-fit hover:text-myst-link" href="https://mystmd.org/made-with-myst" target="_blank" rel="noreferrer"><svg style="width:24px;height:24px" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" stroke="none"><g id="icon"><path fill="currentColor" d="M23.8,54.8v-3.6l4.7-0.8V17.5l-4.7-0.8V13H36l13.4,31.7h0.2l13-31.7h12.6v3.6l-4.7,0.8v32.9l4.7,0.8v3.6h-15 28 v-3.6l4.9-0.8V20.8H65L51.4,53.3h-3.8l-14-32.5h-0.1l0.2,17.4v12.1l5,0.8v3.6H23.8z"></path><path fill="#F37726" d="M47,86.9c0-5.9-3.4-8.8-10.1-8.8h-8.4c-5.2,0-9.4-1.3-12.5-3.8c-3.1-2.5-5.4-6.2-6.8-11l4.8-1.6 29 c1.8,5.6,6.4,8.6,13.8,8.8h9.2c6.4,0,10.8,2.5,13.1,7.5c2.3-5,6.7-7.5,13.1-7.5h8.4c7.8,0,12.7-2.9,14.6-8.7l4.8,1.6 30 c-1.4,4.9-3.6,8.6-6.8,11.1c-3.1,2.5-7.3,3.7-12.4,3.8H63c-6.7,0-10,2.9-10,8.8"></path></g></svg>
30<span class="self-center ml-2 text-sm">Made with MyST</span></a></div></div></div><main class="article-grid grid-gap"><article class="article-grid subgrid-gap col-screen article content"><div class="hidden"></div><div id="skip-to-frontmatter" aria-label="article frontmatter" class="myst-fm-block mb-8 pt-9"><div class="myst-fm-block-header flex items-center mb-5 h-6 text-sm font-light"><div class="flex-grow"></div><div class="myst-fm-block-badges"><a href="https://github.com/jupyter-book/jupyter-book" title="GitHub Repository: jupyter-book/jupyter-book" target="_blank" rel="noopener noreferrer" class="myst-fm-github-link text-inherit hover:text-inherit"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" width="1.25rem" height="1.25rem" class="myst-fm-github-icon inline-block mr-1 opacity-60 hover:opacity-100"><path d="M12 2.5c-5.4 0-9.8 4.4-9.8 9.7 0 4.3 2.8 8 6.7 9.2.5.1.7-.2.7-.5v-1.8c-2.4.5-3.1-.6-3.3-1.1-.1-.3-.6-1.1-1-1.4-.3-.2-.8-.6 0-.6s1.3.7 1.5 1c.9 1.5 2.3 1.1 2.8.8.1-.6.3-1.1.6-1.3-2.2-.2-4.4-1.1-4.4-4.8 0-1.1.4-1.9 1-2.6-.1-.2-.4-1.2.1-2.6 0 0 .8-.3 2.7 1 .8-.2 1.6-.3 2.4-.3.8 0 1.7.1 2.4.3 1.9-1.3 2.7-1 2.7-1 .5 1.3.2 2.3.1 2.6.6.7 1 1.5 1 2.6 0 3.7-2.3 4.6-4.4 4.8.4.3.7.9.7 1.8V21c0 .3.2.6.7.5 3.9-1.3 6.6-4.9 6.6-9.2 0-5.4-4.4-9.8-9.8-9.8z"></path></svg></a></div><a href="https://github.com/jupyter-book/jupyter-book/edit/main/docs/index.md" title="Edit This Page" target="_blank" rel="noopener noreferrer" class="myst-fm-edit-link text-inherit hover:text-inherit"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" width="1.25rem" height="1.25rem" class="myst-fm-edit-icon inline-block mr-1 opacity-60 hover:opacity-100"><path stroke-linecap="round" stroke-linejoin="round" d="m16.862 4.487 1.687-1.688a1.875 1.875 0 1 1 2.652 2.652L10.582 16.07a4.5 4.5 0 0 1-1.897 1.13L6 18l.8-2.685a4.5 4.5 0 0 1 1.13-1.897l8.932-8.931Zm0 0L19.5 7.125M18 14v4.75A2.25 2.25 0 0 1 15.75 21H5.25A2.25 2.25 0 0 1 3 18.75V8.25A2.25 2.25 0 0 1 5.25 6H10"></path></svg></a><div class="myst-fm-downloads-dropdown relative flex inline-block mx-1 grow-0" data-headlessui-state=""><button class="myst-fm-downloads-button relative ml-2 -mr-1" id="headlessui-menu-button-_R_s8ucp_" type="button" aria-haspopup="menu" aria-expanded="false" data-headlessui-state=""><span class="sr-only">Downloads</span><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" width="1.25rem" height="1.25rem" class="myst-fm-downloads-icon stroke-myst-text-tertiary hover:stroke-myst-text"><title>Download</title><path stroke-linecap="round" stroke-linejoin="round" d="M3 16.5v2.25A2.25 2.25 0 0 0 5.25 21h13.5A2.25 2.25 0 0 0 21 18.75V16.5M16.5 12 12 16.5m0 0L7.5 12m4.5 4.5V3"></path></svg></button></div></div><h1 class="myst-fm-block-title mb-0">Jupyter Book User Guide</h1></div><div class="block my-10 lg:sticky lg:z-10 lg:h-0 lg:pt-0 lg:my-0 lg:ml-10 lg:col-margin-right" style="top:60px"><nav></nav></div><div id="skip-to-article"></div><p>Jupyter Book is <a target="_blank" rel="noreferrer" href="https://mystmd.org" class="link whitespace-nowrap"><span class="link-text whitespace-normal">a distribution of the MyST Document Engine</span><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" class="link-icon"><path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25"></path></svg></a>.</p><aside class="myst-admonition myst-admonition-seealso my-5 shadow-md dark:shadow-2xl dark:bg-myst-bg-secondary overflow-hidden myst-admonition-default rounded border-l-4 border-myst-info"><div class="myst-admonition-header m-0 font-medium py-1 flex min-w-0 text-lg text-myst-info-text bg-myst-info-bg"><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" width="2rem" height="2rem" class="myst-admonition-header-icon inline-block pl-2 mr-2 self-center flex-none text-myst-info-text"><path stroke-linecap="round" stroke-linejoin="round" d="m12.75 15 3-3m0 0-3-3m3 3h-7.5M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"></path></svg><div class="myst-admonition-header-text text-myst-text grow self-center overflow-hidden break-words">Looking for the Jupyter Book 1 docs?</div></div><div class="myst-admonition-body px-4 py-1"><p>This documentation is for Jupyter Book 2. If youâre looking for the Jupyter Book 1 docs, go to <a class="link" href="https://jupyterbook.org/v1/intro.html">https://<wbr/>jupyterbook<wbr/>.org<wbr/>/v1<wbr/>/intro<wbr/>.html</a>.</p></div></aside><h2 id="see-mystmd-org-for-more-complete-documentation" class="relative group"><span class="heading-text">See <code>mystmd.org</code> for more complete documentation</span><a class="no-underline text-inherit hover:text-inherit inline-block w-0 px-0 translate-x-[10px] font-normal select-none transition-opacity opacity-0 focus:opacity-100 group-hover:opacity-70" href="#see-mystmd-org-for-more-complete-documentation" title="Link to this Section" aria-label="Link to this Section">¶</a></h2><p>Because Jupyter Book is <a class="link" href="https://jupyterbook.org/community/ecosystem">a distribution of the MyST Document Engine</a>, we keep most documentation about configuring and using Jupyter Book in the <a target="_blank" rel="noreferrer" href="https://mystmd.org/guide" class="link whitespace-nowrap"><span class="link-text whitespace-normal">MyST User Guide</span><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" class="link-icon"><path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25"></path></svg></a>. Anything you can do with <abbr aria-label="Markedly Structured Text" class="hover-text" data-state="closed">MyST</abbr> you can do with Jupyter Book - the only difference in using the two is the <abbr aria-label="Command-Line Interface" class="hover-text" data-state="closed">CLI</abbr> verb (<code>jupyter book</code> vs. <code>myst</code>).</p><h2 id="navigate-the-jupyter-book-documentation" class="relative group"><span class="heading-text">Navigate the Jupyter Book documentation</span><a class="no-underline text-inherit hover:text-inherit inline-block w-0 px-0 translate-x-[10px] font-normal select-none transition-opacity opacity-0 focus:opacity-100 group-hover:opacity-70" href="#navigate-the-jupyter-book-documentation" title="Link to this Section" aria-label="Link to this Section">¶</a></h2><p>This User Guide steps you through <strong>high-level concepts</strong>, <strong>tutorials for step-by-step learning</strong>, and <strong>how-to guides to get things done</strong>. It focuses on use-cases for multi-document projects, like <strong>community knowledge bases</strong> and <strong>multi-page books</strong>.<span id="fnref-FUj1KBvTfQ" class="" data-state="closed"><sup class="hover-link"><a class="no-underline text-inherit hover:text-inherit font-normal hover:underline" href="#fn-diataxis" title="Link to Footnote" aria-label="Link to Footnote">[<!-- -->1<!-- -->]</a></sup></span></p><div class="myst-grid grid my-5 grid-cols-1 md:grid-cols-2 lg:grid-cols-2 xl:grid-cols-2 gap-4"><a class="myst-card my-5 rounded shadow dark:shadow-2xl overflow-hidden border border-myst-border flex flex-col text-inherit hover:text-inherit block font-normal no-underline hover:no-underline cursor-pointer group hover:border-myst-active" href="/stable/get-started/install"><div class="myst-card-body flex-grow px-4 py-2"><div class="myst-card-title pt-3 font-bold group-hover:underline">ð Install & Setup</div><p>Install Jupyter Book and create your first project.</p></div><footer class="myst-card-footer py-1 pl-3 m-0 border-t border-myst-border bg-myst-bg-secondary"><p>Install Jupyter Book »</p></footer></a><a class="myst-card my-5 rounded shadow dark:shadow-2xl overflow-hidden border border-myst-border flex flex-col text-inherit hover:text-inherit block font-normal no-underline hover:no-underline cursor-pointer group hover:border-myst-active" href="/stable/build-and-publish/website"><div class="myst-card-body flex-grow px-4 py-2"><div class="myst-card-title pt-3 font-bold group-hover:underline">ð Build Your First Website</div><p>Step-by-step tutorial to build and publish a website.</p></div><footer class="myst-card-footer py-1 pl-3 m-0 border-t border-myst-border bg-myst-bg-secondary"><p>Build a website tutorial »</p></footer></a><a class="myst-card my-5 rounded shadow dark:shadow-2xl overflow-hidden border border-myst-border flex flex-col text-inherit hover:text-inherit block font-normal no-underline hover:no-underline cursor-pointer group hover:border-myst-active" href="/stable/authoring"><div class="myst-card-body flex-grow px-4 py-2"><div class="myst-card-title pt-3 font-bold group-hover:underline">âï¸ Write Content</div><p>Learn to write with <abbr aria-label="Markedly Structured Text" class="hover-text" data-state="closed">MyST</abbr> Markdown, add figures, citations, and math.</p></div><footer class="myst-card-footer py-1 pl-3 m-0 border-t border-myst-border bg-myst-bg-secondary"><p>Browse authoring guides »</p></footer></a><a class="myst-card my-5 rounded shadow dark:shadow-2xl overflow-hidden border border-myst-border flex flex-col text-inherit hover:text-inherit block font-normal no-underline hover:no-underline cursor-pointer group hover:border-myst-active" href="/stable/build-and-publish"><div class="myst-card-body flex-grow px-4 py-2"><div class="myst-card-title pt-3 font-bold group-hover:underline">ð§ Build & Publish</div><p>Export to PDF, publish to GitHub Pages, and deploy your book.</p></div><footer class="myst-card-footer py-1 pl-3 m-0 border-t border-myst-border bg-myst-bg-secondary"><p>Browse build guides »</p></footer></a></div><h2 id="browse-documentation-by-type" class="relative group"><span class="heading-text">Browse documentation by type</span><a class="no-underline text-inherit hover:text-inherit inline-block w-0 px-0 translate-x-[10px] font-normal select-none transition-opacity opacity-0 focus:opacity-100 group-hover:opacity-70" href="#browse-documentation-by-type" title="Link to this Section" aria-label="Link to this Section">¶</a></h2><p>Looking for something specific? Browse by documentation type:</p><p><strong>Tutorials</strong> - Step-by-step learning paths:</p><ul><li><p><a class="link" href="/stable/build-and-publish/website">Build a website</a> - Create and publish your first site</p></li><li><p><a class="link" href="/stable/execution/execution">Execute code</a> - Run computational notebooks</p></li><li><p><a class="link" href="/stable/plugins/plugins">Create plugins</a> - Extend Jupyter Book with custom directives</p></li></ul><p><strong>How-To Guides</strong> - Solve specific problems:</p><ul><li><p><a class="link" href="/stable/get-started/create-content">Create content</a> - Add pages and structure</p></li><li><p><a class="link" href="/stable/get-started/cross-reference">Cross-reference</a> - Link between sections</p></li><li><p><a class="link" href="/stable/authoring/math">Add math equations</a> - Write LaTeX mathematics</p></li><li><p><a class="link" href="/stable/get-started/export-pdfs">Export to PDF</a> - Generate PDF documents</p></li></ul><p><strong>Reference</strong> - Technical specifications:</p><ul><li><p><a target="_blank" rel="noreferrer" href="https://mystmd.org/guide" class="link whitespace-nowrap"><span class="link-text whitespace-normal">MyST Guide</span><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" class="link-icon"><path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25"></path></svg></a> - Complete <abbr aria-label="Markedly Structured Text" class="hover-text" data-state="closed">MyST</abbr> reference</p></li><li><p><a class="link" href="/stable/authoring/table-of-contents">Table of contents</a> - <abbr aria-label="Table of Contents" class="hover-text" data-state="closed">TOC</abbr> structure</p></li></ul><p><strong>Community</strong> - Get help and contribute:</p><ul><li><p><a class="link" href="https://jupyterbook.org/help">Get help</a> - Discord, discussions, bug reports</p></li><li><p><a class="link" href="/stable/resources/faq">FAQ</a> - Frequently asked questions</p></li><li><p><a class="link" href="https://jupyterbook.org/contribute">Contributing</a>
30 - How to contribute</p></li></ul><div class="myst-backmatter-parts"></div><section id="footnotes" class="myst-footnotes article-grid subgrid-gap col-screen"><div><header class="myst-footnotes-header text-lg font-semibold text-myst-text group">Footnotes<a class="no-underline text-inherit hover:text-inherit ml-2 select-none transition-opacity opacity-0 focus:opacity-100 group-hover:opacity-70" href="#footnotes" title="Link to Footnotes" aria-label="Link to Footnotes">¶</a></header></div><div class="myst-footnotes-list pl-3 mb-8 text-xs text-myst-text-tertiary"><ol><li id="fn-diataxis" class="myst-footnotes-item group"><div class="flex flex-row"><div class="myst-footnote-content break-words grow"><p>The Jupyter Book and <abbr aria-label="Markedly Structured Text" class="hover-text" data-state="closed">MyST</abbr> documentation follow <a target="_blank" rel="noreferrer" href="https://diataxis.fr" class="link whitespace-nowrap"><span class="link-text whitespace-normal">the Diataxis documentation framework</span><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" class="link-icon"><path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25"></path></svg></a>. Within that framework, we aim for <a class="link" href="http://jupyterbook.org">jupyterbook.org</a> to contain <strong>tutorials</strong> and <strong>how-to guides</strong>, and the <a target="_blank" rel="noreferrer" href="https://mystmd.org/guide/" class="link whitespace-nowrap"><span class="link-text whitespace-normal">MyST guide</span><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" class="link-icon"><path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25"></path></svg></a> to focus on <strong>reference documentation</strong> and <strong>deeper explanation</strong>.</p></div><div class="myst-footnote-backlinks flex flex-col grow-0"><a class="no-underline text-inherit hover:text-inherit p-1 select-none [@media(hover:hover)]:transition-opacity [@media(hover:hover)]:opacity-0 [@media(hover:hover)]:focus:opacity-100 [@media(hover:hover)]:group-hover:opacity-70" href="#fnref-FUj1KBvTfQ" title="Link to Content" aria-label="Link to Content">â©</a></div></div></li></ol></div></section><div class="myst-footer-links flex pt-10 mb-10 space-x-4"><a class="myst-footer-link flex-1 block p-4 font-normal text-myst-text-secondary no-underline border border-myst-border rounded shadow-sm group hover:border-myst-active hover:text-myst-active hover:shadow-lg myst-footer-link-next" aria-label="Next: Get started" href="/stable/get-started"><div class="flex h-full align-middle"><div class="flex-grow"><div class="myst-footer-link-group text-xs text-myst-text-tertiary">Jupyter Book User Guide</div>Get started</div><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" data-slot="icon" width="1.5rem" height="1.5rem" class="myst-footer-link-icon self-center transition-transform group-hover:translate-x-1 shrink-0"><path stroke-linecap="round" stroke-linejoin="round" d="M13.5 4.5 21 12m0 0-7.5 7.5M21 12H3"></path></svg></div></a></div></article></main><footer class="article footer article-grid bg-white dark:bg-slate-950 mt-10 shadow-2xl shadow py-10"><div class="relative w-full"></div></footer>
30<script>((a,s)=>{if(!window.history.state||!window.history.state.key){let l=Math.random().toString(32).slice(2);window.history.replaceState({key:l},"")}try{let u=JSON.parse(sessionStorage.getItem(a)||"{}")[s||window.history.state.key];typeof u=="number"&&window.scrollTo(0,u)}catch(l){console.error(l),sessionStorage.removeItem(a)}})("positions", null)</script>
30<script>window.__remixContext = {"url":"/index","state":{"loaderData":{"root":{"config":{"version":3,"myst":"1.11.0","options":{"favicon":"/stable/build/config-item-4ab41af6-6f6593d52577e9440272fc74591dd5ea.ico","logo":"/stable/build/config-item-65699539-b044d4fe0e87b77862847c69bbb05174.svg","logo_dark":"/stable/build/config-item-938b93dc-bfab6677293c5780ea12da96a5b66e8a.svg","logo_url":"/","folders":true,"internal_domains":"jupyterbook.org"},"parts":{"footer":{"mdast":{"type":"root","children":[{"type":"block","children":[{"type":"anywidget","esm":"/stable/build/1a9541c2773ac1be3bfeb49058c51365.mjs","css":"/stable/build/a70d4653232048308c540a3f9b5278f8.css","model":{"title":"Jupyter Book","description":"Create beautiful, publication-quality books and documents from computational content.","logo":"https://raw.githubusercontent.com/jupyter-book/jupyterbook.org/refs/heads/main/docs/media/images/logo-square.svg","copyright":"© 2026 Jupyter Book Contributors. Licensed under BSD-3.","links":{"Documentation":[{"Getting Started":"https://jupyterbook.org/stable/get-started/"},{"User Guide":"https://mystmd.org/guide"},{"Reference":"https://mystmd.org/guide/syntax-overview"}],"Community":[{"GitHub":"https://github.com/jupyter-book"},{"Chat with us":"https://discord.mystmd.org"},{"Contributing":"https://jupyterbook.org/contribute/"}],"Related Projects":[{"MyST Markdown":"https://mystmd.org"},{"MyST Sandbox":"https://mystmd.org/sandbox"},{"Project Jupyter":"https://jupyter.org"}]},"icons":{"github":"https://github.com/jupyter-book","bluesky":"https://bsky.app/profile/mystmd.org","discord":"https://discord.mystmd.org"},"iconSvgs":{}},"key":"zAwdiiFQZY"}],"key":"OhuAuCOc57"}],"key":"t8WkM2nyhe"},"frontmatter":{"parts":{},"github":"https://github.com/jupyter-book/jupyter-book","abbreviations":{"MyST":"Markedly Structured Text","CLI":"Command-Line Interface","TOC":"Table of Contents"},"source_url":"https://github.com/jupyter-book/jupyter-book/blob/main/docs/_build/cache/config-item-9ca35114dd767925e2a2ab88e871dbf1.md","edit_url":"https://github.com/jupyter-book/jupyter-book/edit/main/docs/_build/cache/config-item-9ca35114dd767925e2a2ab88e871dbf1.md"}}},"nav":[{"title":"Docs","url":"https://jupyterbook.org/stable"},{"title":"Community","url":"https://jupyterbook.org/community"},{"title":"Contribute","url":"https://jupyterbook.org/contribute"},{"title":"Blog","url":"https://jupyterbook.org/blog"},{"title":"Help","url":"https://jupyterbook.org/help"}],"actions":[],"projects":[{"abbreviations":{"MyST":"Markedly Structured Text","CLI":"Command-Line Interface","TOC":"Table of Contents"},"github":"https://github.com/jupyter-book/jupyter-book","references":{"guide":{"url":"https://mystmd.org/guide"}},"toc":[{"file":"index.md","title":"User Guide"},{"children":[{"file":"get-started/install.md"},{"file":"get-started/init.md"},{"file":"get-started/create-content.md"},{"file":"get-started/build-websites.md"},{"file":"get-started/export-pdfs.md"},{"file":"get-started/cross-reference.md"},{"file":"get-started/publish.md"}],"file":"get-started/index.md"},{"children":[{"file":"authoring/mystmd.md"},{"file":"authoring/math.md"},{"file":"authoring/authorship.md"},{"file":"authoring/roles-and-directives.md"},{"file":"authoring/table-of-contents.md"},{"file":"authoring/file-types.md"}],"file":"authoring/index.md","title":"Author Content"},{"children":[{"file":"build-and-publish/website.md"},{"file":"build-and-publish/customize.md"},{"file":"build-and-publish/publish.md"},{"file":"build-and-publish/export.md"}],"file":"build-and-publish/index.md","title":"Build \u0026 Publish"},{"children":[{"file":"execution/execution.md"},{"file":"execution/jupyterlab.md"},{"file":"execution/generate-myst.md"}],"file":"execution/index.md","title":"Execute \u0026 Compute"},{"children":[{"file":"plugins/plugins.md"},{"file":"plugins/directives-and-roles.md"},{"file":"plugins/debug.md"},{"file":"plugins/ast.md"},{"file":"plugins/dependencies.md"}],"file":"plugins/index.md","title":"Extend with Plugins"},{"children":[{"file":"resources/faq.md"},{"file":"resources/upgrade.md"},{"file":"resources/downgrade.md"},{"file":"resources/glossary.md"}],"title":"Resources"},{"children":[{"file":"contribute/code.md"},{"file":"contribute/docs.md"},{"file":"contribute/release.md"}],"title":"Contributor Guide"}],"exports":[],"bibliography":[],"title":"Jupyter Book User Guide","index":"index","pages":[{"slug":"get-started.index","title":"Get started","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"get-started.install","title":"Install Jupyter Book","short_title":"Install Jupyter Book","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.init","title":"Initialise a project","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.create-content","title":"Writing in MyST Markdown","short_title":"Add new content","description":"","date":"","thumbnail":"/stable/build/e18f93c1a505d76c1d42cf6b874a6a0d.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.build-websites","title":"Build a website","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.export-pdfs","title":"Export PDFs","description":"","date":"","thumbnail":"/stable/build/bc89eb1d39c4224bd8019fe72296eca8.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.cross-reference","title":"Referencing other books","short_title":"Reference books","description":"","date":"","thumbnail":"/stable/build/21f8f79cc1d584b9e372b7a92cde564f.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.publish","title":"Publish to a website","description":"","date":"","thumbnail":"/stable/build/github-pages-55e4bd7246d8383beb6f506704e4f0b6.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.index","title":"Author Content","short_title":"Author Content","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"authoring.mystmd","title":"Introduction to MyST Markdown","description":"MyST (Markedly Structured Text) is designed to create publication-quality documents written entirely in Markdown.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.math","title":"Math and equations","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.authorship","title":"Add authors and their information to a page","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.roles-and-directives","title":"Use roles and directives","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.table-of-contents","title":"Table of contents structure","description":"Organize your book's pages with the table of contents","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.file-types","title":"Supported file types","description":"File formats you can use in your Jupyter Book","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.index","title":"Build \u0026 Publish","short_title":"Build \u0026 Publish","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1}
30,{"slug":"build-and-publish.website","title":"Get started with websites","description":"Get up and running with Jupyter Book for a simple website.","date":"","thumbnail":"/stable/build/c12ecee91461270887add0109fad9926.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.customize","title":"Customize your website","short_title":"Customize","description":"Theme, navigation, metadata, styles, and other ways to customize a Jupyter Book website.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.publish","title":"Publish to the web","description":"Deployment options for Jupyter Book websites.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.export","title":"Export static documents","description":"Jupyter Book can export your book to a number of different static formats to share with others.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.index","title":"Execute \u0026 Compute","short_title":"Execute \u0026 Compute","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"execution.execution","title":"Get started with executable code","short_title":"Executable code \u0026 content","description":"Learn the basics of how MyST can be used to execute content with Jupyter technology.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.jupyterlab","title":"Author with JupyterLab","description":"MyST Markdown can be used in JupyterLab with support for all MyST syntax as well as inline execution.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.generate-myst","title":"Generate MyST markdown at execution time","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.index","title":"Extend with Plugins","short_title":"Extend with Plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"plugins.plugins","title":"Get started with Jupyter Book plugins","description":"Plugins implemented in JavaScript are easily used across different projects, as they do not require any additional programs to be installed.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.directives-and-roles","title":"Create custom roles, directives, and transforms","short_title":"Create roles, directives, \u0026 transforms","de
30scription":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.debug","title":"Debug plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.ast","title":"Generate MyST AST with Plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.dependencies","title":"Install JavaScript dependencies with your plugin","short_title":"Use packages from npm","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"level":1,"title":"Resources"},{"slug":"resources.faq","title":"Frequently Asked Questions","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.upgrade","title":"Upgrade an existing book from Jupyter Book 1","short_title":"Upgrade from Jupyter Book 1","description":"","date":"","thumbnail":"/stable/build/screenshot-jupyter-b-192aeeba06c49d910aae55d3a1d86b3e.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.downgrade","title":"Downgrade to Jupyter Book 1","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.glossary","title":"Glossary","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"level":1,"title":"Contributor Guide"},{"slug":"contribute.code","title":"Contributing Code to Jupyter Book","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"contribute.docs","title":"Documentation strategy and structure","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"contribute.release","title":"Make a release","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2}]}]},"CONTENT_CDN_PORT":"3100","MODE":"static","BASE_URL":"/stable"},"routes/$":{"config":{"version":3,"myst":"1.11.0","options":{"favicon":"/stable/build/config-item-4ab41af6-6f6593d52577e9440272fc74591dd5ea.ico","logo":"/stable/build/config-item-65699539-b044d4fe0e87b77862847c69bbb05174.svg","logo_dark":"/stable/build/config-item-938b93dc-bfab6677293c5780ea12da96a5b66e8a.svg","logo_url":"/","folders":true,"internal_domains":"jupyterbook.org"},"parts":{"footer":{"mdast":{"type":"root","children":[{"type":"block","children":[{"type":"anywidget","esm":"/stable/build/1a9541c2773ac1be3bfeb49058c51365.mjs","css":"/stable/build/a70d4653232048308c540a3f9b5278f8.css","model":{"title":"Jupyter Book","description":"Create beautiful, publication-quality books and documents from computational content.","logo":"https://raw.githubusercontent.com/jupyter-book/jupyterbook.org/refs/heads/main/docs/media/images/logo-square.svg","copyright":"© 2026 Jupyter Book Contributors. Licensed under BSD-3.","links":{"Documentation":[{"Getting Started":"https://jupyterbook.org/stable/get-started/"},{"User Guide":"https://mystmd.org/guide"},{"Reference":"https://mystmd.org/guide/syntax-overview"}],"Community":[{"GitHub":"https://github.com/jupyter-book"},{"Chat with us":"https://discord.mystmd.org"},{"Contributing":"https://jupyterbook.org/contribute/"}],"Related Projects":[{"MyST Markdown":"https://mystmd.org"},{"MyST Sandbox":"https://mystmd.org/sandbox"},{"Project Jupyter":"https://jupyter.org"}]},"icons":{"github":"https://github.com/jupyter-book","bluesky":"https://bsky.app/profile/mystmd.org","discord":"https://discord.mystmd.org"},"iconSvgs":{}},"key":"zAwdiiFQZY"}],"key":"OhuAuCOc57"}],"key":"t8WkM2nyhe"},"frontmatter":{"parts":{},"github":"https://github.com/jupyter-book/jupyter-book","abbreviations":{"MyST":"Markedly Structured Text","CLI":"Command-Line Interface","TOC":"Table of Contents"},"source_url":"https://github.com/jupyter-book/jupyter-book/blob/main/docs/_build/cache/config-item-9ca35114dd767925e2a2ab88e871dbf1.md","edit_url":"https://github.com/jupyter-book/jupyter-book/edit/main/docs/_build/cache/config-item-9ca35114dd767925e2a2ab88e871dbf1.md"}}},"nav":[{"title":"Docs","url":"https://jupyterbook.org/stable"},{"title":"Community","url":"https://jupyterbook.org/community"},{"title":"Contribute","url":"https://jupyterbook.org/contribute"},{"title":"Blog","url":"https://jupyterbook.org/blog"},{"title":"Help","url":"https://jupyterbook.org/help"}],"actions":[],"projects":[{"abbreviations":{"MyST":"Markedly Structured Text","CLI":"Command-Line Interface","TOC":"Table of Contents"},"github":"https://github.com/jupyter-book/jupyter-book","references":{"guide":{"url":"https://mystmd.org/guide"}},"toc":[{"file":"index.md","title":"User Guide"},{"children":[{"file":"get-started/install.md"},{"file":"get-started/init.md"},{"file":"get-started/create-content.md"},{"file":"get-started/build-websites.md"},{"file":"get-started/export-pdfs.md"},{"file":"get-started/cross-reference.md"},{"file":"get-started/publish.md"}],"file":"get-started/index.md"},{"children":[{"file":"authoring/mystmd.md"},{"file":"authoring/math.md"},{"file":"authoring/authorship.md"},{"file":"authoring/roles-and-directives.md"},{"file":"authoring/table-of-contents.md"},{"file":"authoring/file-types.md"}],"file":"authoring/index.md","title":"Author Content"},{"children":[{"file":"build-and-publish/website.md"},{"file":"build-and-publish/customize.md"},{"file":"build-and-publish/publish.md"},{"file":"build-and-publish/export.md"}],"file":"build-and-publish/index.md","title":"Build \u0026 Publish"},{"children":[{"file":"execution/execution.md"},{"file":"execution/jupyterlab.md"},{"file":"execution/generate-myst.md"}],"file":"execution/index.md","title":"Execute \u0026 Compute"},{"children":[{"file":"plugins/plugins.md"},{"file":"plugins/directives-and-roles.md"},{"file":"plugins/debug.md"},{"file":"plugins/ast.md"},{"file":"plugins/dependencies.md"}],"file":"plugins/index.md","title":"Extend with Plugins"},{"children":[{"file":"resources/faq.md"},{"file":"resources/upgrade.md"},{"file":"resources/downgrade.md"},{"file":"resources/glossary.md"}],"title":"Resources"},{"children":[{"file":"contribute/code.md"},{"file":"contribute/docs.md"},{"file":"contribute/release.md"}],"title":"Contributor Guide"}],"exports":[],"bibliography":[],"title":"Jupyter Book User Guide","index":"index","pages":[{"slug":"get-started.index","title":"Get started","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"get-started.install","title":"Install Jupyter Book","short_title":"Install Jupyter Book","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.init","title":"Initialise a project","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.create-content","title":"Writing in MyST Markdown","short_title":"Add new content","description":"","date":"","thumbnail":"/stable/build/e18f93c1a505d76c1d42cf6b874a6a0d.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.build-websites","title":"Build a website","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.export-pdfs","title":"Export PDFs","description":"","date":"","thumbnail":"/stable/build/bc89eb1d39c4224bd8019fe72296eca8.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.cross-reference","title":"Referencing other books","short_title":"Reference books","description":"","date":"","thumbnail":"/stable/build/21f8f79cc1d584b9e372b7a92cde564f.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.publish","title":"Publish to a website","description":"","date":"","thumbnail":"/stable/build/github-pages-55e4bd7246d8383beb6f506704e4f0b6.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.index","title":"Author Content","short_title":"Author Content","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"authoring.mystmd","title":"Introduction to MyST Markdown","description":"MyST (Markedly Structured Text) is designed to create publication-quality documents written entirely in Markdown.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.math","title":"Math and equations","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.authorship","title":"Add authors and their information to a page","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.roles-and-directives","title":"Use roles and directives","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.table-of-contents","title":"Table of contents structure","description":"Organize your book's pages with the table of contents","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.file-types","title":"Supported file types","description":"File formats you can use in your Jupyter Book","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.index","title":"Build \u0026 Publish","short_title":"Build \u0026 Publish","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1}
30,{"slug":"build-and-publish.website","title":"Get started with websites","description":"Get up and running with Jupyter Book for a simple website.","date":"","thumbnail":"/stable/build/c12ecee91461270887add0109fad9926.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.customize","title":"Customize your website","short_title":"Customize","description":"Theme, navigation, metadata, styles, and other ways to customize a Jupyter Book website.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.publish","title":"Publish to the web","description":"Deployment options for Jupyter Book websites.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.export","title":"Export static documents","description":"Jupyter Book can export your book to a number of different static formats to share with others.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.index","title":"Execute \u0026 Compute","short_title":"Execute \u0026 Compute","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"execution.execution","title":"Get started with executable code","short_title":"Executable code \u0026 content","description":"Learn the basics of how MyST can be used to execute content with Jupyter technology.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.jupyterlab","title":"Author with JupyterLab","description":"MyST Markdown can be used in JupyterLab with support for all MyST syntax as well as inline execution.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.generate-myst","title":"Generate MyST markdown at execution time","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.index","title":"Extend with Plugins","short_title":"Extend with Plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"plugins.plugins","title":"Get started with Jupyter Book plugins","description":"Plugins implemented in JavaScript are easily used across different projects, as they do not require any additional programs to be installed.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.directives-and-roles","title":"Create custom roles, directives, and transforms","short_title":"Create roles, directives, \u0026 transforms","de
30scription":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.debug","title":"Debug plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.ast","title":"Generate MyST AST with Plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.dependencies","title":"Install JavaScript dependencies with your plugin","short_title":"Use packages from npm","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"level":1,"title":"Resources"},{"slug":"resources.faq","title":"Frequently Asked Questions","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.upgrade","title":"Upgrade an existing book from Jupyter Book 1","short_title":"Upgrade from Jupyter Book 1","description":"","date":"","thumbnail":"/stable/build/screenshot-jupyter-b-192aeeba06c49d910aae55d3a1d86b3e.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.downgrade","title":"Downgrade to Jupyter Book 1","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.glossary","title":"Glossary","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"level":1,"title":"Contributor Guide"},{"slug":"contribute.code","title":"Contributing Code to Jupyter Book","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"contribute.docs","title":"Documentation strategy and structure","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"contribute.release","title":"Make a release","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2}]}]},"page":{"version":3,"kind":"Article","sha256":"c8424fe2f6d0143578be416771b46191f68b7f0d82d09cb6f740d2635af9630d","slug":"index","location":"/index.md","dependencies":[],"frontmatter":{"title":"Jupyter Book User Guide","github":"https://github.com/jupyter-book/jupyter-book","abbreviations":{"MyST":"Markedly Structured Text","CLI":"Command-Line Interface","TOC":"Table of Contents"},"source_url":"https://github.com/jupyter-book/jupyter-book/blob/main/docs/index.md","edit_url":"https://github.com/jupyter-book/jupyter-book/edit/main/docs/index.md","exports":[{"format":"md","filename":"index.md","url":"/stable/build/index-3b6c00f37396047c28b05e12225cebd5.md"}]},"mdast":{"type":"root","children":[{"type":"block","children":[{"type":"paragraph","position":{"start":{"line":5,"column":1},"end":{"line":5,"column":1}},"children":[{"type":"text","value":"Jupyter Book is ","position":{"start":{"line":5,"column":1},"end":{"line":5,"column":1}}
30,"key":"eMeyQ10N20"},{"type":"link","url":"https://mystmd.org","position":{"start":{"line":5,"column":1},"end":{"line":5,"column":1}},"children":[{"type":"text","value":"a distribution of the MyST Document Engine","position":{"start":{"line":5,"column":1},"end":{"line":5,"column":1}},"key":"hXPyYCsLG7"}],"urlSource":"https://mystmd.org","key":"HT2NPtqB7c"},{"type":"text","value":".","position":{"start":{"line":5,"column":1},"end":{"line":5,"column":1}},"key":"agZRqY86HE"}],"key":"u0rQ9AsB8L"},{"type":"admonition","kind":"seealso","children":[{"type":"admonitionTitle","children":[{"type":"text","value":"Looking for the Jupyter Book 1 docs?","position":{"start":{"line":7,"column":1},"end":{"line":7,"column":1}},"key":"S4D7cX6odA"}],"key":"oiLvpHDE6k"},{"type":"paragraph","position":{"start":{"line":8,"column":1},"end":{"line":8,"column":1}},"children":[{"type":"text","value":"This documentation is for Jupyter Book 2. If youâre looking for the Jupyter Book 1 docs, go to ","position":{"start":{"line":8,"column":1},"end":{"line":8,"column":1}}
30,"key":"myTjNUABvN"},{"type":"link","url":"https://jupyterbook.org/v1/intro.html","position":{"start":{"line":8,"column":1},"end":{"line":8,"column":1}},"children":[{"type":"text","value":"https://âjupyterbookâ.orgâ/v1â/introâ.html","position":{"start":{"line":8,"column":1},"end":{"line":8,"column":1}},"key":"H3ttd2BPA4"}],"urlSource":"https://jupyterbook.org/v1/intro.html","key":"znKXctvLO3"},{"type":"text","value":".","position":{"start":{"line":8,"column":1},"end":{"line":8,"column":1}},"key":"QmS8Ib1lhy"}],"key":"fbPdZW2MCJ"}],"key":"eyjnlSAAxN"},{"type":"heading","depth":2,"position":{"start":{"line":11,"column":1},"end":{"line":11,"column":1}},"children":[{"type":"text","value":"See ","position":{"start":{"line":11,"column":1},"end":{"line":11,"column":1}},"key":"WpJRq2tREU"},{"type":"inlineCode","value":"mystmd.org","position":{"start":{"line":11,"column":1},"end":{"line":11,"column":1}},"key":"jnpGEg6Kxi"},{"type":"text","value":" for more complete documentation","position":{"start":{"line":11,"column":1},"end":{"line":11,"column":1}}
30,"key":"ayatBB4u2V"}],"identifier":"see-mystmd-org-for-more-complete-documentation","label":"See mystmd.org for more complete documentation","html_id":"see-mystmd-org-for-more-complete-documentation","implicit":true,"key":"CFvB60zoTG"},{"type":"paragraph","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"children":[{"type":"text","value":"Because Jupyter Book is ","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"key":"iZlOHXSDMH"},{"type":"link","url":"https://jupyterbook.org/community/ecosystem","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"children":[{"type":"text","value":"a distribution of the MyST Document Engine","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"key":"U6J6vj7NaE"}],"urlSource":"https://jupyterbook.org/community/ecosystem","key":"iNMGn0OZZv"},{"type":"text","value":", we keep most documentation about configuring and using Jupyter Book in the ","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}}
30,"key":"Py4yoRvPDO"},{"type":"link","url":"https://mystmd.org/guide","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"children":[{"type":"text","value":"MyST User Guide","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"key":"yBa8UP4f4O"}],"urlSource":"https://mystmd.org/guide","key":"aXB2KKnycf"},{"type":"text","value":". Anything you can do with ","key":"em7lsFh8JN"},{"type":"abbreviation","title":"Markedly Structured Text","children":[{"type":"text","value":"MyST","key":"rZjJe42sIu"}],"key":"rQ7GFFZ0iR"},{"type":"text","value":" you can do with Jupyter Book - the only difference in using the two is the ","key":"rM7ZrRqkYS"},{"type":"abbreviation","title":"Command-Line Interface","children":[{"type":"text","value":"CLI","key":"Pe8JvC7TTT"}],"key":"AU0jIgm04h"},{"type":"text","value":" verb (","key":"b7sWQ0CLhe"},{"type":"inlineCode","value":"jupyter book","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"key":"bZrKq2W0Qy"},{"type":"text","value":" vs. ","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}}
30,"key":"XIJqJ4wFQx"},{"type":"inlineCode","value":"myst","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"key":"jVoP30vwlp"},{"type":"text","value":").","position":{"start":{"line":13,"column":1},"end":{"line":13,"column":1}},"key":"OJJfilntjm"}],"key":"yP8oTjsGeW"},{"type":"heading","depth":2,"position":{"start":{"line":15,"column":1},"end":{"line":15,"column":1}},"children":[{"type":"text","value":"Navigate the Jupyter Book documentation","position":{"start":{"line":15,"column":1},"end":{"line":15,"column":1}},"key":"XJLGCVtvPi"}],"identifier":"navigate-the-jupyter-book-documentation","label":"Navigate the Jupyter Book documentation","html_id":"navigate-the-jupyter-book-documentation","implicit":true,"key":"lhSNEOBk4q"},{"type":"paragraph","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"children":[{"type":"text","value":"This User Guide steps you through ","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"R7VC50sD3b"},{"type":"strong","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"children":[{"type":"text","value":"high-level concepts","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}}
30,"key":"fyFaT6nH1U"}],"key":"AHks5EiVzX"},{"type":"text","value":", ","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"AU5YO5kW5Z"},{"type":"strong","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"children":[{"type":"text","value":"tutorials for step-by-step learning","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"Ko6yQ4B2eR"}],"key":"UtKUjS8MVk"},{"type":"text","value":", and ","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"t5xweGD1kc"},{"type":"strong","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"children":[{"type":"text","value":"how-to guides to get things done","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"w02T2TFBO3"}],"key":"ZcxOKym4ni"},{"type":"text","value":". It focuses on use-cases for multi-document projects, like ","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"QB06rQHiKk"},{"type":"strong","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"children":[{"type":"text","value":"community knowledge bases","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}}
30,"key":"sQnPqyfMDy"}],"key":"F0tYApXV1v"},{"type":"text","value":" and ","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"rTAMyY6mAO"},{"type":"strong","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"children":[{"type":"text","value":"multi-page books","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"XirS8xwZPS"}],"key":"qQKSPL1q1z"},{"type":"text","value":".","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"key":"tWFavQXU8B"},{"type":"footnoteReference","identifier":"diataxis","label":"diataxis","position":{"start":{"line":17,"column":1},"end":{"line":17,"column":1}},"enumerator":"1","key":"FUj1KBvTfQ"}],"key":"nkPkuQ9sT3"},{"type":"grid","columns":[1,2,2,2],"children":[{"type":"card","url":"/get-started/install","children":[{"type":"cardTitle","children":[{"type":"text","value":"ð Install \u0026 Setup","position":{"start":{"line":23,"column":1},"end":{"line":23,"column":1}},"key":"o0N8N9jwwo"}],"key":"xkPjpGqnzf"},{"type":"paragraph","position":{"start":{"line":27,"column":1},"end":{"line":27,"column":1}},"children":[{"type":"text","value":"Install Jupyter Book and create your first project.","position":{"start":{"line":27,"column":1},"end":{"line":27,"column":1}}
30,"key":"YEcfOCWYy0"}],"key":"JeMA2wGPQc"},{"type":"footer","children":[{"type":"paragraph","children":[{"type":"text","value":"Install Jupyter Book »","position":{"start":{"line":25,"column":1},"end":{"line":25,"column":1}},"key":"W9C6xVsDAa"}],"key":"nAnzOgdJ3F"}],"key":"zpIlrh2Vmx"}],"urlSource":"get-started/install.md","dataUrl":"/get-started.install.json","internal":true,"protocol":"file","key":"ryf8nCZFSH"},{"type":"card","url":"/build-and-publish/website","children":[{"type":"cardTitle","children":[{"type":"text","value":"ð Build Your First Website","position":{"start":{"line":29,"column":1},"end":{"line":29,"column":1}},"key":"NvnAYA7y7a"}],"key":"hHyo7Ed7td"},{"type":"paragraph","position":{"start":{"line":33,"column":1},"end":{"line":33,"column":1}},"children":[{"type":"text","value":"Step-by-step tutorial to build and publish a website.","position":{"start":{"line":33,"column":1},"end":{"line":33,"column":1}},"key":"qWhtd4z1he"}],"key":"YDPf5ubrfO"},{"type":"footer","children":[{"type":"paragraph","children":[{"type":"text","value":"Build a website tutorial »","position":{"start":{"line":31,"column":1},"end":{"line":31,"column":1}}
30,"key":"Ve9NBnm84H"}],"key":"VS0PHshqDE"}],"key":"a9tJAU3CL7"}],"urlSource":"build-and-publish/website.md","dataUrl":"/build-and-publish.website.json","internal":true,"protocol":"file","key":"eQDIh36e3H"},{"type":"card","url":"/authoring","children":[{"type":"cardTitle","children":[{"type":"text","value":"âï¸ Write Content","position":{"start":{"line":35,"column":1},"end":{"line":35,"column":1}},"key":"HGADVBgZK2"}],"key":"d3BG2gMx0y"},{"type":"paragraph","position":{"start":{"line":39,"column":1},"end":{"line":39,"column":1}},"children":[{"type":"text","value":"Learn to write with ","key":"JVaRcWqEiP"},{"type":"abbreviation","title":"Markedly Structured Text","children":[{"type":"text","value":"MyST","key":"pZyj5IRHTQ"}],"key":"jee6aZ4Gdz"},{"type":"text","value":" Markdown, add figures, citations, and math.","key":"txDaKFb9QX"}],"key":"zxAxbj1i8b"},{"type":"footer","children":[{"type":"paragraph","children":[{"type":"text","value":"Browse authoring guides »","position":{"start":{"line":37,"column":1},"end":{"line":37,"column":1}}
30,"key":"p0ZqEtJgWv"}],"key":"kMKVDrXMm6"}],"key":"lvQ347hdrk"}],"urlSource":"authoring/index.md","dataUrl":"/authoring.index.json","internal":true,"protocol":"file","key":"BMBB8TOGNZ"},{"type":"card","url":"/build-and-publish","children":[{"type":"cardTitle","children":[{"type":"text","value":"ð§ Build \u0026 Publish","position":{"start":{"line":41,"column":1},"end":{"line":41,"column":1}},"key":"IV1mWssu8n"}],"key":"Gm6n0mTTE4"},{"type":"paragraph","position":{"start":{"line":45,"column":1},"end":{"line":45,"column":1}},"children":[{"type":"text","value":"Export to PDF, publish to GitHub Pages, and deploy your book.","position":{"start":{"line":45,"column":1},"end":{"line":45,"column":1}},"key":"o2yovdedXs"}],"key":"bWKpkUj9Aj"},{"type":"footer","children":[{"type":"paragraph","children":[{"type":"text","value":"Browse build guides »","position":{"start":{"line":43,"column":1},"end":{"line":43,"column":1}},"key":"zRidszhILf"}],"key":"UIxZKLZWWB"}],"key":"fWoWwBRzmJ"}],"urlSource":"build-and-publish/index.md","dataUrl":"/build-and-publish.index.json","internal":true,"protocol":"file","key":"unp1UwhVKT"}],"key":"Q6KjclzuWI"},{"type":"heading","depth":2,"position":{"start":{"line":49,"column":1},"end":{"line":49,"column":1}},"children":[{"type":"text","value":"Browse documentation by type","position":{"start":{"line":49,"column":1},"end":{"line":49,"column":1}}
30,"key":"EHuZh4ecJP"}],"identifier":"browse-documentation-by-type","label":"Browse documentation by type","html_id":"browse-documentation-by-type","implicit":true,"key":"LEULDR2rFD"},{"type":"paragraph","position":{"start":{"line":51,"column":1},"end":{"line":51,"column":1}},"children":[{"type":"text","value":"Looking for something specific? Browse by documentation type:","position":{"start":{"line":51,"column":1},"end":{"line":51,"column":1}},"key":"jOfvsvmKQW"}],"key":"cTscraI7VY"},{"type":"paragraph","position":{"start":{"line":53,"column":1},"end":{"line":53,"column":1}},"children":[{"type":"strong","position":{"start":{"line":53,"column":1},"end":{"line":53,"column":1}},"children":[{"type":"text","value":"Tutorials","position":{"start":{"line":53,"column":1},"end":{"line":53,"column":1}},"key":"nQ0IDe36Cp"}],"key":"C8QARd8CzP"},{"type":"text","value":" - Step-by-step learning paths:","position":{"start":{"line":53,"column":1},"end":{"line":53,"column":1}},"key":"W1690ML4BG"}],"key":"sgv1rFjAnl"},{"type":"list","ordered":false,"spread":false,"position":{"start":{"line":54,"column":1},"end":{"line":57,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":54,"column":1},"end":{"line":54,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/build-and-publish/website","position":{"start":{"line":54,"column":1},"end":{"line":54,"column":1}},"children":[{"type":"text","value":"Build a website","position":{"start":{"line":54,"column":1},"end":{"line":54,"column":1}}
30,"key":"T3ZOCufamS"}],"urlSource":"./build-and-publish/website.md","dataUrl":"/build-and-publish.website.json","internal":true,"protocol":"file","key":"eBvhHAL6oN"},{"type":"text","value":" - Create and publish your first site","position":{"start":{"line":54,"column":1},"end":{"line":54,"column":1}},"key":"owmFK1PPrI"}],"key":"PxpGJwllnL"}],"key":"JfjHzvIfrp"},{"type":"listItem","spread":true,"position":{"start":{"line":55,"column":1},"end":{"line":55,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/execution/execution","position":{"start":{"line":55,"column":1},"end":{"line":55,"column":1}},"children":[{"type":"text","value":"Execute code","position":{"start":{"line":55,"column":1},"end":{"line":55,"column":1}},"key":"woib6iuZZu"}],"urlSource":"./execution/execution.md","dataUrl":"/execution.execution.json","internal":true,"protocol":"file","key":"o0W7BkY7vm"},{"type":"text","value":" - Run computational notebooks","position":{"start":{"line":55,"column":1},"end":{"line":55,"column":1}}
30,"key":"h2rpZyRxDg"}],"key":"NDZdBXMASD"}],"key":"ZQUD6pcpHf"},{"type":"listItem","spread":true,"position":{"start":{"line":56,"column":1},"end":{"line":57,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/plugins/plugins","position":{"start":{"line":56,"column":1},"end":{"line":56,"column":1}},"children":[{"type":"text","value":"Create plugins","position":{"start":{"line":56,"column":1},"end":{"line":56,"column":1}},"key":"rvosWEo1Xm"}],"urlSource":"./plugins/plugins.md","dataUrl":"/plugins.plugins.json","internal":true,"protocol":"file","key":"FiqhUQbip6"},{"type":"text","value":" - Extend Jupyter Book with custom directives","position":{"start":{"line":56,"column":1},"end":{"line":56,"column":1}},"key":"uNEZ69ouA6"}],"key":"ScdPFbmxwx"}],"key":"h6jBeMJiFa"}],"key":"I6u7kfFKOH"},{"type":"paragraph","position":{"start":{"line":58,"column":1},"end":{"line":58,"column":1}},"children":[{"type":"strong","position":{"start":{"line":58,"column":1},"end":{"line":58,"column":1}},"children":[{"type":"text","value":"How-To Guides","position":{"start":{"line":58,"column":1},"end":{"line":58,"column":1}}
30,"key":"KoTkymedDu"}],"key":"hIeCLN80SO"},{"type":"text","value":" - Solve specific problems:","position":{"start":{"line":58,"column":1},"end":{"line":58,"column":1}},"key":"kURjl9LTre"}],"key":"oYcAlCJHpT"},{"type":"list","ordered":false,"spread":false,"position":{"start":{"line":59,"column":1},"end":{"line":63,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":59,"column":1},"end":{"line":59,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/get-started/create-content","position":{"start":{"line":59,"column":1},"end":{"line":59,"column":1}},"children":[{"type":"text","value":"Create content","position":{"start":{"line":59,"column":1},"end":{"line":59,"column":1}},"key":"lnUY61Cz11"}],"urlSource":"./get-started/create-content.md","dataUrl":"/get-started.create-content.json","internal":true,"protocol":"file","key":"bib5RDNTps"},{"type":"text","value":" - Add pages and structure","position":{"start":{"line":59,"column":1},"end":{"line":59,"column":1}},"key":"DLjzDZHxEY"}],"key":"E4iZvwnR7J"}],"key":"pZQ3MQp9Hm"},{"type":"listItem","spread":true,"position":{"start":{"line":60,"column":1},"end":{"line":60,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/get-started/cross-reference","position":{"start":{"line":60,"column":1},"end":{"line":60,"column":1}},"children":[{"type":"text","value":"Cross-reference","position":{"start":{"line":60,"column":1},"end":{"line":60,"column":1}}
30,"key":"zcXMHRRz3U"}],"urlSource":"./get-started/cross-reference.md","dataUrl":"/get-started.cross-reference.json","internal":true,"protocol":"file","key":"zAFliX5pD7"},{"type":"text","value":" - Link between sections","position":{"start":{"line":60,"column":1},"end":{"line":60,"column":1}},"key":"B11k9VftTC"}],"key":"e8fEnm8W5y"}],"key":"QIMlYJsh2T"},{"type":"listItem","spread":true,"position":{"start":{"line":61,"column":1},"end":{"line":61,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/authoring/math","position":{"start":{"line":61,"column":1},"end":{"line":61,"column":1}},"children":[{"type":"text","value":"Add math equations","position":{"start":{"line":61,"column":1},"end":{"line":61,"column":1}},"key":"a6EtGs2nBv"}],"urlSource":"./authoring/math.md","dataUrl":"/authoring.math.json","internal":true,"protocol":"file","key":"fWYu2kFU1g"},{"type":"text","value":" - Write LaTeX mathematics","position":{"start":{"line":61,"column":1},"end":{"line":61,"column":1}},"key":"eR3lccrLEM"}],"key":"UUvX4pj59n"}],"key":"uMWOUJUuVi"},{"type":"listItem","spread":true,"position":{"start":{"line":62,"column":1},"end":{"line":63,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/get-started/export-pdfs","position":{"start":{"line":62,"column":1},"end":{"line":62,"column":1}},"children":[{"type":"text","value":"Export to PDF","position":{"start":{"line":62,"column":1},"end":{"line":62,"column":1}}
30,"key":"ztEhHwFQYI"}],"urlSource":"./get-started/export-pdfs.md","dataUrl":"/get-started.export-pdfs.json","internal":true,"protocol":"file","key":"mo7L67MhbH"},{"type":"text","value":" - Generate PDF documents","position":{"start":{"line":62,"column":1},"end":{"line":62,"column":1}},"key":"HAHIvxUGtK"}],"key":"kNCJjMsXwa"}],"key":"aOhOLWBYz4"}],"key":"cKUyRxAASG"},{"type":"paragraph","position":{"start":{"line":64,"column":1},"end":{"line":64,"column":1}},"children":[{"type":"strong","position":{"start":{"line":64,"column":1},"end":{"line":64,"column":1}},"children":[{"type":"text","value":"Reference","position":{"start":{"line":64,"column":1},"end":{"line":64,"column":1}},"key":"AsCTr8Mmdk"}],"key":"iajfRc8YhQ"},{"type":"text","value":" - Technical specifications:","position":{"start":{"line":64,"column":1},"end":{"line":64,"column":1}},"key":"I2fmoGfFFA"}],"key":"rbYBVCymMf"},{"type":"list","ordered":false,"spread":false,"position":{"start":{"line":65,"column":1},"end":{"line":67,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":65,"column":1},"end":{"line":65,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"https://mystmd.org/guide","position":{"start":{"line":65,"column":1},"end":{"line":65,"column":1}},"children":[{"type":"text","value":"MyST Guide","position":{"start":{"line":65,"column":1},"end":{"line":65,"column":1}}
30,"key":"tS8koejBG3"}],"urlSource":"https://mystmd.org/guide","key":"pRusH15hHa"},{"type":"text","value":" - Complete ","key":"ubiGPAR8RN"},{"type":"abbreviation","title":"Markedly Structured Text","children":[{"type":"text","value":"MyST","key":"Ty1vFNGwhV"}],"key":"hbGU95p2GU"},{"type":"text","value":" reference","key":"qjxhtID7IC"}],"key":"MEnxeS7cGN"}],"key":"qA69pkKn80"},{"type":"listItem","spread":true,"position":{"start":{"line":66,"column":1},"end":{"line":67,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/authoring/table-of-contents","position":{"start":{"line":66,"column":1},"end":{"line":66,"column":1}},"children":[{"type":"text","value":"Table of contents","position":{"start":{"line":66,"column":1},"end":{"line":66,"column":1}},"key":"ZQM8a95D4X"}],"urlSource":"./authoring/table-of-contents.md","dataUrl":"/authoring.table-of-contents.json","internal":true,"protocol":"file","key":"u6PA75qYa6"},{"type":"text","value":" - ","key":"sotF02nBBa"},{"type":"abbreviation","title":"Table of Contents","children":[{"type":"text","value":"TOC","key":"iwQPoyQCLS"}],"key":"KyTeO9LH0Y"},{"type":"text","value":" structure","key":"FzcgqOmaJI"}],"key":"uPSx9q1bA8"}],"key":"ErF2Hk4gmN"}],"key":"gMXJL8RiHX"},{"type":"paragraph","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}},"children":[{"type":"strong","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}},"children":[{"type":"text","value":"Community","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}}
30,"key":"qKGRcmhhzO"}],"key":"nk2cpT312k"},{"type":"text","value":" - Get help and contribute:","position":{"start":{"line":68,"column":1},"end":{"line":68,"column":1}},"key":"wq5AImrQxZ"}],"key":"oHZSG8Gqqo"},{"type":"list","ordered":false,"spread":false,"position":{"start":{"line":69,"column":1},"end":{"line":71,"column":1}},"children":[{"type":"listItem","spread":true,"position":{"start":{"line":69,"column":1},"end":{"line":69,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"https://jupyterbook.org/help","position":{"start":{"line":69,"column":1},"end":{"line":69,"column":1}},"children":[{"type":"text","value":"Get help","position":{"start":{"line":69,"column":1},"end":{"line":69,"column":1}},"key":"N6rO9nA9in"}],"urlSource":"https://jupyterbook.org/help","key":"cwt960km16"},{"type":"text","value":" - Discord, discussions, bug reports","position":{"start":{"line":69,"column":1},"end":{"line":69,"column":1}},"key":"fjI99typH5"}],"key":"loDZJmpToj"}],"key":"Yj09h4uaOo"},{"type":"listItem","spread":true,"position":{"start":{"line":70,"column":1},"end":{"line":70,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"/resources/faq","position":{"start":{"line":70,"column":1},"end":{"line":70,"column":1}},"children":[{"type":"text","value":"FAQ","position":{"start":{"line":70,"column":1},"end":{"line":70,"column":1}}
30,"key":"izPh2th8ll"}],"urlSource":"./resources/faq.md","dataUrl":"/resources.faq.json","internal":true,"protocol":"file","key":"j9GO0gsXyh"},{"type":"text","value":" - Frequently asked questions","position":{"start":{"line":70,"column":1},"end":{"line":70,"column":1}},"key":"xMrV11Vwar"}],"key":"GHYhuidRtI"}],"key":"tJxTPaWHgT"},{"type":"listItem","spread":true,"position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"children":[{"type":"paragraph","children":[{"type":"link","url":"https://jupyterbook.org/contribute","position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"children":[{"type":"text","value":"Contributing","position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"key":"spuxX1C7un"}],"urlSource":"https://jupyterbook.org/contribute","key":"ElsdqeZjpt"},{"type":"text","value":" - How to contribute","position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"key":"sqZ9LAryjB"}],"key":"DYgT745K8I"}],"key":"kvAu61bgs1"}],"key":"QBmND7C2v2"},{"type":"footnoteDefinition","identifier":"diataxis","label":"diataxis","position":{"start":{"line":71,"column":1},"end":{"line":71,"column":1}},"children":[{"type":"paragraph","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"The Jupyter Book and ","key":"HBlgXbsnec"},{"type":"abbreviation","title":"Markedly Structured Text","children":[{"type":"text","value":"MyST","key":"lkhTC9Q7uG"}],"key":"fP3ti5qLyg"},{"type":"text","value":" documentation follow ","key":"ddV3jLZvDu"},{"type":"link","url":"https://diataxis.fr","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"the Diataxis documentation framework","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}}
30,"key":"oofDl12eNL"}],"urlSource":"https://diataxis.fr","key":"aCgDOxx192"},{"type":"text","value":". Within that framework, we aim for ","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"c5lkekNd6L"},{"type":"link","url":"http://jupyterbook.org","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"jupyterbook.org","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"Zq8qdwbOYB"}],"urlSource":"http://jupyterbook.org","key":"iKy2133SL9"},{"type":"text","value":" to contain ","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"HNTGm3jTwB"},{"type":"strong","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"tutorials","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"HHygglfdHZ"}],"key":"XkighRR0D5"},{"type":"text","value":" and ","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}}
30,"key":"CCzdPYYcX8"},{"type":"strong","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"how-to guides","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"GKqmSUdYiQ"}],"key":"baMswsOVEO"},{"type":"text","value":", and the ","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"o1x5Lvuxfn"},{"type":"link","url":"https://mystmd.org/guide/","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"MyST guide","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"rWN8YNsitr"}],"urlSource":"xref:guide","dataUrl":"https://mystmd.org/guide/index.json","internal":false,"protocol":"xref:myst","key":"A4oVyXe6HK"},{"type":"text","value":" to focus on ","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"a6wEIAHoV8"},{"type":"strong","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"reference documentation","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}}
30,"key":"uMpKT2a082"}],"key":"x57bwkpUBs"},{"type":"text","value":" and ","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"tC0dIWNt6i"},{"type":"strong","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"children":[{"type":"text","value":"deeper explanation","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"cOvCfbPdFS"}],"key":"Ry5qbbk2eE"},{"type":"text","value":".","position":{"start":{"line":19,"column":1},"end":{"line":19,"column":1}},"key":"Ule2mpPMRn"}],"key":"ANKmwYb7pr"}],"enumerator":"1","key":"IrfhMwRTZH"}],"key":"ORcMmCQ7Lc"}],"key":"xc7GIzw6zw"},"references":{"cite":{"order":[],"data":{}}},"footer":{"navigation":{"next":{"title":"Get started","url":"/get-started","group":"Jupyter Book User Guide"}}},"domain":"http://localhost:3000"},"project":{"abbreviations":{"MyST":"Markedly Structured Text","CLI":"Command-Line Interface","TOC":"Table of Contents"},"github":"https://github.com/jupyter-book/jupyter-book","references":{"guide":{"url":"https://mystmd.org/guide"}},"toc":[{"file":"index.md","title":"User Guide"},{"children":[{"file":"get-started/install.md"},{"file":"get-started/init.md"},{"file":"get-started/create-content.md"},{"file":"get-started/build-websites.md"},{"file":"get-started/export-pdfs.md"},{"file":"get-started/cross-reference.md"},{"file":"get-started/publish.md"}],"file":"get-started/index.md"},{"children":[{"file":"authoring/mystmd.md"},{"file":"authoring/math.md"},{"file":"authoring/authorship.md"},{"file":"authoring/roles-and-directives.md"},{"file":"authoring/table-of-contents.md"},{"file":"authoring/file-types.md"}],"file":"authoring/index.md","title":"Author Content"},{"children":[{"file":"build-and-publish/website.md"},{"file":"build-and-publish/customize.md"},{"file":"build-and-publish/publish.md"},{"file":"build-and-publish/export.md"}],"file":"build-and-publish/index.md","title":"Build \u0026 Publish"},{"children":[{"file":"execution/execution.md"},{"file":"execution/jupyterlab.md"},{"file":"execution/generate-myst.md"}],"file":"execution/index.md","title":"Execute \u0026 Compute"},{"children":[{"file":"plugins/plugins.md"},{"file":"plugins/directives-and-roles.md"},{"file":"plugins/debug.md"},{"file":"plugins/ast.md"},{"file":"plugins/dependencies.md"}],"file":"plugins/index.md","title":"Extend with Plugins"},{"children":[{"file":"resources/faq.md"},{"file":"resources/upgrade.md"},{"file":"resources/downgrade.md"},{"file":"resources/glossary.md"}],"title":"Resources"},{"children":[{"file":"contribute/code.md"},{"file":"contribute/docs.md"},{"file":"contribute/release.md"}],"title":"Contributor Guide"}],"exports":[],"bibliography":[],"title":"Jupyter Book User Guide","index":"index","pages":[{"slug":"get-started.index","title":"Get started","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"get-started.install","title":"Install Jupyter Book","short_title":"Install Jupyter Book","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.init","title":"Initialise a project","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.create-content","title":"Writing in MyST Markdown","short_title":"Add new content","description":"","date":"","thumbnail":"/stable/build/e18f93c1a505d76c1d42cf6b874a6a0d.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.build-websites","title":"Build a website","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.export-pdfs","title":"Export PDFs","description":"","date":"","thumbnail":"/stable/build/bc89eb1d39c4224bd8019fe72296eca8.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.cross-reference","title":"Referencing other books","short_title":"Reference books","description":"","date":"","thumbnail":"/stable/build/21f8f79cc1d584b9e372b7a92cde564f.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"get-started.publish","title":"Publish to a website","description":"","date":"","thumbnail":"/stable/build/github-pages-55e4bd7246d8383beb6f506704e4f0b6.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.index","title":"Author Content","short_title":"Author Content","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"authoring.mystmd","title":"Introduction to MyST Markdown","description":"MyST (Markedly Structured Text) is designed to create publication-quality documents written entirely in Markdown.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.math","title":"Math and equations","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.authorship","title":"Add authors and their information to a page","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.roles-and-directives","title":"Use roles and directives","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.table-of-contents","title":"Table of contents structure","description":"Organize your book's pages with the table of contents","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"authoring.file-types","title":"Supported file types","description":"File formats you can use in your Jupyter Book","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.index","title":"Build \u0026 Publish","short_title":"Build \u0026 Publish","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1}
30,{"slug":"build-and-publish.website","title":"Get started with websites","description":"Get up and running with Jupyter Book for a simple website.","date":"","thumbnail":"/stable/build/c12ecee91461270887add0109fad9926.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.customize","title":"Customize your website","short_title":"Customize","description":"Theme, navigation, metadata, styles, and other ways to customize a Jupyter Book website.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.publish","title":"Publish to the web","description":"Deployment options for Jupyter Book websites.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"build-and-publish.export","title":"Export static documents","description":"Jupyter Book can export your book to a number of different static formats to share with others.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.index","title":"Execute \u0026 Compute","short_title":"Execute \u0026 Compute","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"execution.execution","title":"Get started with executable code","short_title":"Executable code \u0026 content","description":"Learn the basics of how MyST can be used to execute content with Jupyter technology.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.jupyterlab","title":"Author with JupyterLab","description":"MyST Markdown can be used in JupyterLab with support for all MyST syntax as well as inline execution.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"execution.generate-myst","title":"Generate MyST markdown at execution time","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.index","title":"Extend with Plugins","short_title":"Extend with Plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":1},{"slug":"plugins.plugins","title":"Get started with Jupyter Book plugins","description":"Plugins implemented in JavaScript are easily used across different projects, as they do not require any additional programs to be installed.","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.directives-and-roles","title":"Create custom roles, directives, and transforms","short_title":"Create roles, directives, \u0026 transforms","de
30scription":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.debug","title":"Debug plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.ast","title":"Generate MyST AST with Plugins","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"plugins.dependencies","title":"Install JavaScript dependencies with your plugin","short_title":"Use packages from npm","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"level":1,"title":"Resources"},{"slug":"resources.faq","title":"Frequently Asked Questions","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.upgrade","title":"Upgrade an existing book from Jupyter Book 1","short_title":"Upgrade from Jupyter Book 1","description":"","date":"","thumbnail":"/stable/build/screenshot-jupyter-b-192aeeba06c49d910aae55d3a1d86b3e.png","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.downgrade","title":"Downgrade to Jupyter Book 1","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"resources.glossary","title":"Glossary","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"level":1,"title":"Contributor Guide"},{"slug":"contribute.code","title":"Contributing Code to Jupyter Book","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"contribute.docs","title":"Documentation strategy and structure","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2},{"slug":"contribute.release","title":"Make a release","description":"","date":"","thumbnail":"","thumbnailOptimized":"","banner":"","bannerOptimized":"","tags":[],"level":2}]}}},"actionData":null,"errors":null},"future":{"unstable_dev":false,"unstable_postcss":false,"unstable_tailwind":false,"v2_errorBoundary":true,"v2_headers":true,"v2_meta":true,"v2_normalizeFormMethod":true,"v2_routeConvention":true}};</script>
30<script type="module" async="">import "/stable/build/manifest-0F78CC2B.js"; 31import * as route0 from "/stable/build/root-C5CK33H3.js"; 32import * as route1 from "/stable/build/routes/$-6ALOT4PW.js"; 33window.__remixRouteModules = {"root":route0,"routes/$":route1}; 34 35import("/stable/build/entry.client-NNNALS5X.js");</script>
35</body></html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.