Skip to content

Latest commit

 

History

History
117 lines (83 loc) · 5.15 KB

intro.md

File metadata and controls

117 lines (83 loc) · 5.15 KB

Books with Jupyter

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2561065.svg)](https://doi.org/10.5281/zenodo.2561065)
[![Jupyter Book Badge](images/badge.svg)](https://jupyterbook.org)

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:

:::{panels} :container: +full-width text-center :column: col-lg-6 px-2 py-2 :card:

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 , . 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!

:::{admonition} Learn more and get involved :class: tip full-width

💡 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 resources

Here are a few pointers to help you get started.

:::{panels} :container: +full-width :column: col-lg-4 px-2 py-2

:header: bg-jb-one Get started ^^^

: a step-by-step tutorial to get started.

: get started with a simple template book.


:header: bg-jb-two

Learn more ^^^ : Learn how to structure and organize your content.

: Learn how to write rich narrative content.

: Write computational content.

:header: bg-jb-three

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. :::

Acknowledgements

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

:::{image} https://sloan.org/storage/app/media/uploaded-files/Logo-1B-SMALL-Gold-Blue.png :class: float-left mr-2 rounded :width: 150px :::

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