Jupyter _images/logo-square.svg 速览

DOI

Jupyter Book 是一个开源项目,用于从计算材料中构建漂亮且具有出版质量的书籍和文档。

以下是 Jupyter Book 的一些特点:

使用 Jupyter Markdown, MyST Markdown,以及更多发布功能reStructuredTextJupyter Notebooks,或 任何 Jupytext 格式

包括对富文本语法的支持,如引用和交叉引用数学和等式,以及

构建多页的书籍单页文章,并从中生成多种输出,如 HTML 网站PDF 输出。Jupyter Book 使用 Sphinx 文档引擎,支持多种输出类型

本文档分为几个主要部分。

  • 教程是 Jupyter Book 的一步步的介绍性指南。

  • 主题指南更深入地涵盖了特定领域,并被组织为离散的“如何”部分。

  • 参考章节详细描述了 Jupyter Book 的 API/语法 等细节。

这个网站就是 Jupyter Book 建立的!探索左边的章节来了解更多!

了解更多并参与其中

💡 打开议题

通过 GitHub issue 跟踪增强请求、bug 报告和待办事项。

💬 加入讨论

社区论坛上进行社区讨论,讨论想法,分享一般性问题和反馈。

👍 为新功能投票

社区通过在我们的存储库中添加👍对问题的反应来提供反馈。您可以在 Executable Books 问题排行榜 中找到一个最重要的问题列表。

🙌 对 Jupyter Book 有所贡献

通过遵循我们的贡献指南,找到需要解决的问题。查看 功能投票排行榜 以获得灵感。

🙌 加入社区

Jupyter Book 是由可执行书籍社区开发的。我们欢迎任何人加入我们改进 Jupyter Book 并帮助彼此学习和创建他们的书。想要加入,请查看我们的贡献指南

找到正确的文档资源

这里有一些建议可以帮助你开始。

快速入门

创建你的第一本书:一个循序渐进的入门教程。

自动创建书:从一本简单的模板书开始。

了解更多

组织你的书:学习如何结构化和组织内容。

撰写叙述内容:学习如何写丰富的叙事内容。

写可执行内容:编写计算性内容。

灵感

The Jupyter Book Gallery:包含大量由 Jupyter Book 创建书籍的社区画廊。

The QuantEcon Python Lectures:一个由自定义 Jupyter Book 主题构建的完整的数学教科书。

致谢

Jupyter Book 由一个开放的贡献者社区支持,其中很多人来自可执行书籍社区Jupyter 社区

https://pbs.twimg.com/profile_images/1226944724365447169/MzFpwY5P_400x400.png

非常感谢 Sloan 基金会为可执行图书项目提供支持