jupyter-book icon indicating copy to clipboard operation
jupyter-book copied to clipboard

Documentation to add to Jupyter Book 2 from JB 1 and the MyST Guide

Open choldgraf opened this issue 10 months ago • 0 comments

Our short-term goal is to build out Jupyter Book 2's "tutorials" and "how-to" documentation, with a focus on multi-page documentation and books workflows. There's a lot of content already at jupyterbook.org as well as mystmd.org/guide that's relevant to this, and as a first step we can adapt those pages for re-use in Jupyter Book.

This is an issue to keep track of the major items. Each of the sections below will either be a parent category with sub-pages, or a single page with sub-sections, based on how much content is there. We should default to having one page with several sections, and switch to sub-pages once there are multiple sections with many sub-sections such that it's confusing to parse the whole thing.

  • Basics (core functionality)
    • Initialize a book
    • Preview the result
    • Clean outputs
    • List templates
    • Use the Jupyter Book CLI: Brief overview of the major verbs supported by the CLI
    • Structure and organize content: Should be a high-level overview of how to organize a Jupyter Book, and link out to the MyST docs for more information about the Table of Contents structure.
  • Authoring Content (topics around creating content, agnostic to build output, focus on multi-page needs)
    • MyST Markdown Basics: Basic overview of writing content with MyST and links back to the MyST guide. Move "https://next.jupyterbook.org/author/roles-and-directives" into a section of this page.
    • References and bibliographies
    • Math, proofs, etc
    • Attribution and authorship
    • Index pages and glossaries
    • Figures and images
    • Embedding across pages
    • Page layout basics (margins, controlling sidebars, etc)
  • Execution and Computation (topics around execution and Jupyter). Execute at build time, label and embed outputs, etc.
  • Websites (topics around controlling functionality with HTML exports)
  • Static Export (topics around controlling different static outputs)
    • PDF (Latex)
    • PDF (Typst)
    • DOCX
    • Markdown
  • Reference
    • Glossary / Index
    • MySTMD
    • Changelog
  • About (ecosystem / toolchain, about the team, links to mystmd)

choldgraf avatar Jan 07 '25 20:01 choldgraf