| sd_hide_title |
|---|
true |
::::{grid} :reverse: :gutter: 3 4 4 4 :margin: 1 2 1 2
:::{grid-item} :columns: 12 4 4 4
:width: 200px
:class: sd-m-auto
:::
:::{grid-item} :columns: 12 8 8 8 :child-align: justify :class: sd-fs-5
A Sphinx and Docutils extension for compiling Jupyter Notebooks into high quality documentation formats.
:ref-type: doc
:color: primary
:class: sd-rounded-pill
Get Started
:::
::::
::::{grid} 1 2 2 3 :gutter: 1 1 1 2
:::{grid-item-card} {material-regular}edit_note;2em Write
:link: authoring/intro
:link-type: ref
Mix Jupyter notebooks with text-based notebooks, Markdown and RST documents.
Use MyST Markdown syntax to support technical authoring features such as cross-referencing, figures, and admonitions.
+++ Learn more » :::
:::{grid-item-card} {material-regular}published_with_changes;2em Compute
:link: execute/intro
:link-type: ref
Generate dynamic outputs using Jupyter kernels, with configurable execution handling.
Cache execution outputs, for fast re-builds.
+++ Learn more » :::
:::{grid-item-card} {material-regular}preview;2em Render
:link: render/code-cells
:link-type: ref
Convert Jupyter execution outputs to rich embedded content.
Insert computed variables within the document flow.
Build single or collections of documents into multiple formats (HTML, PDF, ...).
+++ Learn more » :::
::::
MyST-NB is a module within the Executable Books Project, an international collaboration to build open source tools that facilitate publishing computational narratives using the Jupyter ecosystem. It is also a core component of Jupyter Book.
Check out the Gallery of Jupyter Books, for inspiration from across the community.
See also, the MyST-Markdown VS Code extension and jupyterlab-myst, for editor tools to author your notebooks.
:hidden:
:maxdepth: 2
quickstart
:caption: Guides
:hidden:
:maxdepth: 2
authoring/index
computation/index
render/index
configuration
docutils
:caption: Reference
:hidden:
:titlesonly:
:maxdepth: 1
reference/api
reference/changelog
reference/contributing