executablebooks/jupyter-book
Jupyter Book
Jupyter Book is a computational book publisher and static site generator that converts Jupyter notebooks and markdown files into interactive web books and publication-quality PDF documents. It serves as a markdown-based documentation tool that executes embedded code at build time and caches the resulting outputs for static display.
The system distinguishes itself by supporting interactive data publications, allowing readers to engage with live computational widgets and launch notebooks in remote execution environments. It extends standard markdown with a system of roles and directives to support scientific authoring, including LaTeX mathematics, bibliography citation management, and numbered cross-references.
The platform covers a broad range of capabilities including academic formatting for proofs and theorems, interactive layout management via collapsible panels, and complex referencing across internal sections and external projects. It also provides tools for content organization through hierarchical book structures and a decoupled table of contents.
The project includes utilities for web hosting integration and content integrity validation to scan for broken references during the build process.
Features
- Digital Book Generation - Converts Jupyter notebooks and markdown files into interactive web-based books and publication-quality PDF documents.
- Notebook-to-Static-Site Generators - Converts Jupyter notebooks and markdown files into a collection of linked static HTML pages for web hosting.
- Jupyter Notebook Publishing - Creates interactive web books or PDFs from Jupyter notebooks and Markdown by embedding live code execution results.
- Academic Authoring - Supports authoring academic papers and textbooks with LaTeX mathematics, bibliography citations, and professional typesetting.
- Build-Time Computational Execution - Runs embedded computational cells during the build process and caches the resulting outputs for static display.
- Computational Book Publishers - Serves as a system for creating publication-quality documents that execute embedded code and cache resulting outputs.
- Markdown Extensions - Extends standard markdown with custom block and inline directives to generate structured HTML or PDF content.
- Cross-Publication Referencing - Tracks unique labels across pages and files to generate automatic hyperlinks and citations within the final publication.
- Document Cross-Referencing - Implements linking between sections, figures, tables, and code objects within and across technical projects.
- Computational Web Books - Converts notebooks and markdown into a structured website that preserves computational interactivity and formatting.
- Markdown Conversions - Transforms Markdown, notebooks, and LaTeX files into professional web books or PDF documents.
- Page Structure Definitions - Defines the hierarchical nesting and sequence of pages to control the navigation sidebar.
- Semantic Markup Extensions - Extends standard Markdown with roles and directives to add structured semantics to inline text and block elements.
- Technical Content Sites - Organizes complex sets of notebooks and markdown files into structured, hierarchical digital publications.
- Interactive Technical Documents - Builds technical websites where readers can explore data via embedded widgets and remote notebook execution.
- Markdown Documentation Tools - Provides a generator that extends standard Markdown with roles and directives for academic and technical documentation.
- Interactive Computing Platforms - Provides a platform for building websites that embed live computational widgets and link to remote execution environments.
- Notebook Code Execution - Runs code within notebooks and markdown files during the build process to generate and display computational results.
- Interactive Data Renderers - Displays rich, interactive outputs and widgets within the rendered website for a dynamic user experience.
- Interactive Widgets - Integrates custom UI components into pages using a standardized specification for interactive elements.
- Interactive Execution Environments - Publishes websites with live widgets and browser-based execution environments for interactive data exploration.
- Content Generation Directives - Defines new block-level or inline elements that process arguments to generate specific structured content.
- Publication Cross-Referencing - Creates rich cross-references between different publications featuring hover-previews of target content.
- Interactive Solution Toggles - Authors exercises with solutions that can be toggled between hidden and visible states.
- Compilation Workflow Customizers - Adds custom functionality to the build process through a plugin system to modify how content is handled.
- Academic Content Formatting - Integrates rich syntax for citations, cross-references, and numbered equations into computational documents.
- Computational Output Referencing - Provides the ability to assign unique labels to specific code execution results for cross-referencing and embedding.
- Document Exporting - Transforms digital book content into fixed-format files such as PDFs for offline distribution.
- AST Transformations - Implements programmatic modification of document structure by manipulating an abstract syntax tree during the rendering phase.
- Static Hosting Deployments - Converts computational material into publication-quality static websites for online distribution.
- Bibliography Formatters - Provides automated rendering and styling of bibliographies from BibTeX files throughout the document.
- LaTeX Publishing - Transforms structured digital content into professionally typeset, print-ready PDF documents using LaTeX.
- Equation Numbering - Assigns unique labels to equations to enable automatic numbering and cross-page hyperlinking.
- PDF Document Generation - Converts computational projects into typeset PDF files using templates for journals or preprints.
- PDF Exports - Transforms notebooks and Markdown files into a print-ready PDF format for offline distribution.
- Decoupled Table of Contents - Stores the table of contents in a separate dedicated file to isolate project configuration from hierarchy.
- Publication Plugin Systems - Creates custom directives and roles using compatible scripts to add new content types or modify document structure.
- Reusable Content Fragments - Embeds fragments from other pages or external sources to avoid duplicating content.
- Static Report Generation - Transforms computational workflows into static documents by running code at build time and caching outputs.
- Computational Result Caching - Embeds results generated in one notebook across multiple pages to avoid redundant calculations.
- Content Node Transformers - Implements transforms that operate on the abstract syntax tree to programmatically alter page content during build.
- Project Metadata Configurations - Uses centralized project-level metadata files to define settings, author information, and site branding.
- Build Pipeline Extensions - Adds custom directives and transforms via scripts or plugins to modify document structure during the build.
- Single-File Site Configurations - Defines project-wide information like authors and licenses via a single configuration file for consistent branding.
- In-Browser Code Execution - Includes live computational results in documentation by running various programming languages at build time.
- Theorem and Proof Formatting - Creates numbered, referenceable theorems, lemmas, and proofs using academic formatting.
- LaTeX Embeddings - Integrates raw LaTeX for complex mathematical formulas and academic typesetting.
- Mathematical Typesetting - Renders LaTeX-style mathematics in web and PDF formats for high-quality typesetting of complex formulas.
- Document Processing Pipelines - Provides a plugin system that allows external scripts to inject custom logic and transforms into the document processing workflow.
- Computational Content Caching - Runs code cells within documents and caches outputs to automate the generation of computational material.
- Interactive Layout Management - Organizes content into collapsible dropdowns, card grids, and tabbed panels to manage information density.
- Rich Text Formatting Extensions - Extends standard Markdown with typographic formatting extensions like footnotes and definition lists.
- Documentation and Processing - Tool for building books from Jupyter notebooks.
- Publishing and Conversion - Builds publication-quality books from computational notebook content.
- Documentation and Knowledge - Builds publication-quality documents from Jupyter Notebooks.
