# jupyter-book/jupyter-book

Create beautiful, publication-quality books and documents from computational content.

Repository: https://github.com/jupyter-book/jupyter-book
Canonical: https://ross.abutalabs.com/products/jupyter-book
Homepage: https://jupyterbook.org
Language: TypeScript
License: BSD-3-Clause
License Family: permissive
Topics: jupyter, documentation-generator, markdown, notebooks, scientific-writing
Last push: 2026-08-08T16:10:16+00:00

## Health v2 (maintenance only)
Score: 91/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 96, release rhythm 80, longevity 100
- inputs: {"age_days": 3003, "days_push": 25, "days_rel": 59, "gap_med": 48, "n_releases_24m": 10}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4273, forks 730 (observed 2026-08-28T04:08:40.992919+00:00)

## What it is
Jupyter Book is an open-source tool for building publication-quality books, documentation sites, and PDFs from Markdown and Jupyter notebooks, with executable code cells, citations, and cross-references. Version 2 is an opinionated distribution of the MyST Document Engine (mystmd), rewritten in TypeScript for faster builds.

## Use cases
- build a publication-quality book from jupyter notebooks
- publish computational documentation as a website
- execute notebook code cells at build time and cache outputs
- export markdown and notebooks to pdf with citations and math
- create a community knowledge base from multiple markdown pages
- write scientific documents with cross-references and numbered equations
- deploy a reproducible research book to github pages

## When to choose
- you want to turn notebooks and markdown into an interactive website or PDF
- you need reproducible, executable computational content in documentation
- you are starting a new multi-page book or knowledge base project
- you want fast builds and modern web features via the MyST engine

## When to avoid
- you rely heavily on custom Sphinx extensions (incompatible with Jupyter Book 2)
- you need features still missing in v2 like blogs, slides, or theming
- you have a stable Jupyter Book 1 workflow and don't want to migrate
- you need a general-purpose static site generator unrelated to computational content

## Facets
- artifact type: cli-tool
- maturity: active
- function: static-site-generator, documentation, markdown, pdf, cli
- domain: documentation, data-science, education, developer-tools
- platform: cli, python, cross-platform
- tags: jupyter, notebooks, myst-markdown, computational-narratives, reproducibility, sphinx, scientific-publishing, executable-content, scientific-writing, nodejs, web-server

## Member repositories
- jupyter-book/jupyter-book (main) score 91

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:40.992919+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:22:00.553419+00:00, confidence not recorded.
  - readme: https://github.com/jupyter-book/jupyter-book (fetched 2026-08-28T04:08:40.992919+00:00, sha 9ea41602b3e1)
  - homepage: https://jupyterbook.org (fetched 2026-08-29T09:11:51.387231+00:00, sha 854cc84b73c8)
  - registry_npm: https://registry.npmjs.org/jupyter-book (fetched 2026-08-29T09:11:51.402697+00:00, sha 2af8732de5b8)
  - site_page: https://jupyterbook.org/stable (fetched 2026-08-29T09:11:51.389855+00:00, sha eeb71d561f4a)
  - site_page: https://jupyterbook.org/stable/resources/faq (fetched 2026-08-29T09:11:51.391773+00:00, sha b5607a003672)
  - site_page: https://jupyterbook.org/v1 (fetched 2026-08-29T09:11:51.394616+00:00, sha 44136fa355b3)
  - site_page: https://jupyterbook.org/stable/resources/upgrade (fetched 2026-08-29T09:11:51.396177+00:00, sha d7b18f6a624b)
  - site_page: https://jupyterbook.org/help (fetched 2026-08-29T09:11:51.397851+00:00, sha 136c99c77f0e)
  - site_page: https://jupyterbook.org/vote (fetched 2026-08-29T09:11:51.399315+00:00, sha ea319200b910)
  - site_page: https://jupyterbook.org/community/ecosystem (fetched 2026-08-29T09:11:51.400935+00:00, sha bdacd532e8fc)
- Data as of 2026-08-30T08:39:29.467469+00:00.