Glossary¶
A glossary of common terms used throughout Jupyter Book.
- CommonMark
A standard syntax of Markdown that is used across many communities and projects. It is the base flavour of Markdown for Jupyter Notebook, and the base flavour for MyST Markdown and Jupyter Book.
- ExecutableBookProject
The project that supports and develops many of the core tools used by Jupyter Book.
- MyST
A flavour of Markdown that was designed for use with the Sphinx project. It is a combination of CommonMark Markdown and a few extra syntax pieces to support features of Sphinx, so that you can write Sphinx documentation in plain Markdown. It is one of the core technologies that Jupyter Book uses.
- MyST-Parser
A parser for Sphinx that allows it to read in content that is written in MyST Markdown. It is also used by MyST-NB to parse MyST Markdown that is inside Jupyter notebooks.
- MyST-NB
An extension for Sphinx that uses the MyST-Parser to parse Jupyter notebooks directly into Sphinx. This also allows users to write MyST Markdown inside of notebooks that are parsed with Sphinx. It is one of the core technologies that Jupyter Book uses.
- Sphinx
A documentation engine written in Python. Sphinx supports many features that are necessary for scientific and scholarly publishing. It is one of the core technologies that Jupyter Book uses.
- Binder
A free, public service for running reproducible interactive computing environments. Binder is a 100% open source infrastructure that is run by members of the Jupyter community. The underlying technology behind the Binder project is BinderHub.
- BinderHub
The underlying technology of mybinder.org, BinderHub is an open source tool that runs on Kubernetes and utilizes a JupyterHub in order to provide live, reproducible interactive computing environments that users host on GitHub.
- Google Colab
A Jupyter Notebook service from Google that provides access to free computing resources, including GPUs and TPUs.
- JupyterHub
A core open source tool from the Jupyter community, JupyterHub allows you to deploy an application that provides remote data science environments to multiple users. It can be deployed in the cloud, or on your own hardware.
- Jupyter-Cache
An open source tool for executing and caching the outputs of Jupyter Notebook content. Outputs are cached in a hidden folder so that they do not need to be included directly with your source files.
- Sphinx-Book-Theme
A customized version of the PyData Sphinx Theme that defines the look and feel of Jupyter Book.