Ecosystem of tools#
There are several major tools that we have developed, or are contributing to, as a part of this project. This page describes a few major components.
An extensible, semantic, and community-driven flavor of markdown designed for scientific and computational narratives.
MyST Markdown is a language- and implementation-agnostic flavor of markdown with support from several tools (some of which are stewarded by us and listed below).
myst-tools.orgis a landing page about the project.
spec.myst-tools.orgdescribes the MyST specification.
MyST Enhancement Proposals a process for proposing and deciding on modifications to the MyST specification.
See below for examples of implementations and tools that use MyST Markdown.
A command-line interface for building beautiful, publication-quality books and documents from computational content.
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.
jupyterbook.orgis the landing page about the project.
gallery.jupyterbook.orgis a gallery of Jupyter Books that community members have submitted.
executablebooks/jupyterbookis our repository where you can contribute and open issues.
Jupyter Book gets most of its functionality from the collection of open source tools in Python and Sphinx that are listed below. You can use each tool on its own for your own purposes, or bring them together with Jupyter Book.
The core of this project’s initial efforts. These are a collection of tools that rely on Sphinx’s documentation engine for creating computational narratives.
MyST - Markedly Structured Text#
A Sphinx parser for MyST Markdown. MyST allows you to write Sphinx documentation entirely in markdown.
MyST has the following main features:
A markdown parser for Sphinx. You can write your entire Sphinx documentation in markdown.
Call Sphinx directives and roles from within Markdown, allowing you to extend your document via Sphinx extensions.
Extended Markdown syntax for useful rST features, such as line commenting and footnotes.
A Sphinx-independent parser of MyST markdown that can be extended to add new functionality and outputs for MyST.
A superset of CommonMark markdown. Any CommonMark markdown (such as Jupyter Notebook markdown) is natively supported by the MyST parser.
A Sphinx extension for executing and reading Jupyter Notebooks with MyST Markdown.
It provides the following primary features:
Parse ipynb files in Sphinx. Directly convert Jupyter Notebooks into Sphinx documents.
Execute and Cache your notebook content. Save time building your documentation without needing to commit your notebook outputs directly into
Write MyST Markdown. MyST Markdown allows you to write Sphinx roles and directives in markdown.
Insert notebook outputs into your content. Generate outputs as you build your documentation, and insert them across pages.
Write Jupyter Notebooks entirely with Markdown. You can define the structure of a notebook in pure-text making it more diff-able.
In addition, there are several options for controlling the look and feel of how your notebooks are used in your documentation.
Sphinx Book Theme#
A lightweight Sphinx theme designed to mimic the look-and-feel of an interactive book.
It has the following primary features:
Bootstrap 4 for visual elements and functionality.
Flexible content layout that is inspired by beautiful online books, such as the Edward Tufte CSS guide
Visual classes designed for Jupyter Notebooks. Cell inputs, outputs, and interactive functionality are all supported.
Launch buttons for online interactivity. For pages that are built with computational material, connect your site to an online BinderHub for interactive content.
A collection of Sphinx extensions#
In addition to these major tools described above, the EBP also maintains a number of tools in the Sphinx ecosystem for writing beautiful online books and documents. For example:
These are tools written in Python but meant to be re-used across many projects.
Allows you to execute and cache notebook files so that you only re-run them when you need to.
This packages provides a clear API and CLI for staging, executing and cacheing Jupyter Notebooks. Although there are certainly other use cases, the principle use case this was written for is generating books / websites, created from multiple notebooks (and other text documents), during which it is desired that notebooks can be auto-executed only if the notebook had been modified in a way that may alter its code cell outputs.
A markdown parser done right. Fast and easy to extend.
markdown-it-py is a Python port of the very popular markdown-it
package. Its goal is to remain as close as possible to the
markdown-it API and plugin spec.
Here are its main features:
Follows the CommonMark spec for baseline parsing
Configurable syntax: You can add new rules and even replace existing ones
Pluggable: Adds syntax extensions to extend the parser (see the plugin list)
High speed (see our benchmarking tests)
It leverages mybinder.org or jupyterlite.
A JupyterLab extension that allows users to write MyST Markdown in Jupyter Notebooks via JupyterLab.