Supported file types

Jupyter Book supports several file types for your book content. This page covers the major types and how they’re used.

Allowed content types¶

Jupyter Book supports the following file types:

Markdown files (.md)

Text files written in MyST Markdown. These are ideal for static content like text, images, and links. See Introduction to MyST Markdown for details about MyST syntax.

Markdown notebooks

Markdown files that can be executed as notebooks. MyST supports text-based notebook formats that are easier to version control than .ipynb files.

Jupyter notebooks (.ipynb)

Standard Jupyter notebook files containing code cells, markdown cells, and outputs. These can use any Jupyter kernel (Python, R, Julia, etc.). Notebook markdown cells can include MyST Markdown syntax.

Rules for all content types¶

There are a few rules that apply to all content types:

• Files must have a title. This means they should begin with a level-1 heading (a line starting with #) or have a title in their frontmatter.

• Use only one top-level header. Each page must have only one title. Hence, don’t use multiple # headings.

• Headers should increase linearly. If you’re inside a section with one #, the next nested section should start with ##.

Supported kernels¶

Jupyter Book can execute notebooks with any Jupyter kernel:

• Python (most common)

• R - via IRkernel

• Julia - via IJulia

• And many more kernels supported by Jupyter

Next steps¶

• Introduction to MyST Markdown - Learn MyST Markdown syntax

• Writing in MyST Markdown - Start creating content

• Get started with executable code - Configure notebook execution