Glossary¶
- 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.
- Project Jupyter
- The project and team that supports Jupyter Book and MyST Markdown and the tools and packages behind them.
- ExecutableBookProject
- The project and team that used to support Jupyter Book and MyST Markdown. The project is currently stewarded by Project Jupyter.
- MyST Markdown
- A flavour of Markdown that was designed for scientific and technical writing.
- Sometimes referred to simply as MyST.
- MyST
- MyST can either refer to the markup syntax or the command-line interface.
- Markup Syntax: MyST is a flavour of Markdown that was designed for scientific and technical writing. MyST is a combination of CommonMark Markdown and extra syntax to support technical writing, such as cross-references, citations, equations and figures. For clarity in this usage, use MyST Markdown.
- Command-Line Interface: MyST is a parser and set of command-line tools for creating websites and documents. For clarity in this usage, use MyST-CLI.
- MyST-CLI
- The MyST Markdown CLI can be used to create a website, PDF documents, and generally structure and parse a MyST project. You can install across various package managers using
mystmd. - Sometimes referred to simply as MyST.
- Sphinx
- A documentation engine written in Python. Sphinx supports many features that are necessary for scientific and scholarly publishing. It is currently used by Jupyter Book.
- reStructuredText
- reStructuredText (RST) is a plain text markup syntax and parser system, the RST parser is a component of Docutils.
- 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 https://
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 Book
- Jupyter Book is a distribution of Sphinx that allows you to write content in markdown and Jupyter Notebooks, execute content and insert it into your book, and build a variety of outputs for interactivity and document publishing.
Index¶
- B
- Binder: Binder
- C
- CommonMark: CommonMark
- E
- ExecutableBookProject: ExecutableBookProject
- G
- Google Colab: Google Colab
- I
- index: index
index child: Paragraph
- J
- Jupyter Book: Jupyter Book
- M
- MyST: MyST
- P
- Project Jupyter: Project Jupyter
- R
- reStructuredText: reStructuredText
- S
- Sphinx: Sphinx
- T
- term: term
