https://jupyterbook.org/intro.html

logo
[                    ]
Tutorials

  * Create your first book [ ]
      + Overview
      + Create your book's source files
      + Build your book
      + Publish your book online
      + Build a small example project
  * Get started with references

Topic Guides

  * Structure and organize your content [ ]
      + Structure the Table of Contents
      + Configure the Table of Contents
      + Types of content source files [ ]
          o Markdown files
          o Jupyter Notebook files
          o Notebooks written entirely in Markdown
          o Custom notebook formats and Jupytext
          o reStructuredText files
      + Create books automatically
      + How headers and sections map onto to book structure
  * Write narrative content [ ]
      + MyST Markdown overview
      + Special content blocks
      + References and cross-references
      + Control the page layout
      + Citations and bibliographies
      + Math and equations
      + Images and figures
      + Add metadata to your book pages
  * Write executable content [ ]
      + Execute and cache your pages
      + Formatting code outputs
      + Store code outputs and insert into content
      + Interactive data visualizations
  * Build your book outputs [ ]
      + Use the Build command line interface
      + Build a PDF
  * Web and internet features [ ]
      + Connect your book to a code repository
      + Hide or remove content
      + Launch into interactive computing interfaces
      + Make your code cells executable
      + Commenting and annotating [ ]
          o Hypothesis
          o Utterances
      + Generate a badge for your book
      + Host your book on the internet [ ]
          o GitHub Pages and Actions
          o Publish with Netlify
      + Advanced HTML outputs
  * Advanced Jupyter Book Usage [ ]
      + Advanced Sphinx usage
      + Developer workflows
      + Working on Windows
      + How Jupyter Book and Sphinx relate to one another
  * Contribute to Jupyter Book

Reference

  * Configuration reference
  * MyST syntax cheat sheet
  * The command-line interface
  * Glossary

About Jupyter Book

  * Gallery of Jupyter Books
  * The Jupyter Book toolchain and components
  * Cite Jupyter Book
  * Change log

Powered by Jupyter Book
.md .pdf
repository open issue suggest edit
Contents

  * Find the right documentation resources
  * Acknowledgements

Books with Jupyter _images/logo-square.svgP

DOI Jupyter Book Badge

Jupyter Book is an open source project for building beautiful,
publication-quality books and documents from computational material.

Here are some of the features of Jupyter Book:

Publication-quality content 

Write in either Jupyter Markdown, MyST Markdown for more publishing
features, reStructuredText, Jupyter Notebooks, or any Jupytext format
. Includes support for rich syntax such as citations and
cross-references, math and equations, and figures.

Execute, cache, and insert computational content 

Execute notebook cells, then format and insert the latest outputs
into your book. Cache outputs to save time in re-building later. Even
save notebook outputs and insert them into other pages.

Add interactivity to content and outputs 

Create interactive content blocks such as Tabbed content, Dropdowns.
Toggle cell visibility and include interactive cell outputs with
Jupyter notebooks. Launch interactive sessions with Binder or Colab,
make your code executable with Thebe, or connect with commenting
services like Hypothes.is.

Build books and articles in many formats 

Build multi-page books or single articles, and generate many kinds of
outputs from them, such as HTML websites or PDF outputs. Jupyter Book
uses the Sphinx Documentation engine which supports a variety of
output types.

This documentation is organized into a few major sections.

  * Tutorials are step-by-step introductory guides to Jupyter Book.

  * Topic Guides cover specific areas in more depth, and are
    organized as discrete "how-to" sections.

  * Reference sections describe the API/syntax/etc of Jupyter Book in
    detail.

This website is built with Jupyter Book! Explore the chapters to the
left to learn more!

Learn more and get involved

 Open an issue

    We track enhancement requests, bug-reports, and to-do items via
    GitHub issues.

 Join the discussion

    We have community discussions, talk about ideas, and share
    general questions and feedback in our community forum.

 Vote for new features

    The community provides feedback by adding a  reaction to issues
    in our repositories. You can find a list of the top issues in the
    Executable Books issue leader board.

 Join the community

    Jupyter Book is developed by the Executable Books community. We
    welcome anyone to join us in improving Jupyter Book and helping
    one another learn and create their books. To join, check out our
    contributing guide.

Find the right documentation resourcesP

Here are a few pointers to help you get started.

Get started

Create your first book: a step-by-step tutorial to get started.

Create books automatically: get started with a simple template book.

Learn more

Structure and organize your content: Learn how to structure and
organize your content.

Write narrative content: Learn how to write rich narrative content.

Write executable content: Write computational content.

Be inspired

The Jupyter Book Gallery: A gallery of community books that have been
created with Jupyter Book.

The QuantEcon Python Lectures: A full mathematical textbook built
with a customer Jupyter Book theme.

AcknowledgementsP

Jupyter Book is supported by an open community of contributors, many
of whom come from the Executable Books Community and the Jupyter
community.

https://sloan.org/storage/app/media/uploaded-files/
Logo-1B-SMALL-Gold-Blue.png

Many thanks to the Sloan Foundation, which provides support for the
Executable Books Project.

 

next

Create your first book

By The Jupyter Book Community
(c) Copyright 2021.