Minimum Viable Product of Jupyter Book functionality with MyST

[choldgraf]

We're tracking a laundry list of MyST functionality in this issue. There's a lot of functionality in there, and that issue doesn't prioritize or define the essential vs. "nice to have" functionality we'd want to see.

In order to move forward the initiative on a myst backend for Jupyter Book , I think we should define the minimal functionality that makes "Jupyter Book via the MyST engine" safe to try. That can be the guiding principle to drive @agoose77's work once we've finished up the launch initiative .

Principles to guide this work

• Principles to guide the Jupyter Book transition from Sphinx to MyST #1113

Minimal functionality needed to use Jupyter Book with MyST

Here's a starting point, we can change or update this as we wish:

MyST engine

• 🆙 Upgrade Jupyter Books in myst init #1223
• Jupytext notebook support #1245
• Support for CSV table directive #893
• 🪆 Add support for nested parsing #1091
• Add a new table of contents format #1102
• 💬 Add epigraph, pull-quote and blockquote directive #961
• Support custom favicons #925
• Unreliable DOI resolution for some DOIs #947
• Lots of errors when building a book PDF with typst #1003
• Reference external MyST sites with labels and standard reference syntax (xref) #1111
• 📥 Load TOC from toc entry #1188
• Allow for cross-page bibliographies #946
• tableofcontents directive
• glue directive
• bibliography directive
• - Deprecation / migration pathways
  • Support legacy glue code and raise a warning to point people to a new way

Documentation

• Add documentation entry for "MyST vs Sphinx" #1094
• Clarify the options for static site hosting and "live server" hosting #927
• 📖 Improve accessible figures with Jupyter docs #1077
• 📖 Update Jupyter documentation #1069
• 📖 Add dedicated exports and downloads pages #1064
• 📖 Embedding documentation #1020
• Improve the developer onboarding documentation #1081

Book theme

• Add {margin} directive myst-theme#327
• Social previews are not generated with HTML builds myst-theme#332
• Support folder hierarchies and nested files in URLs without flattening them #670
• Support for icon links for social, github, external links, etc myst-theme#362
• Add an "Edit this page" button myst-theme#326
• Show "on this page" navigation menu for in-page navigation on mobile myst-theme#363
• Support Search in MyST Sites #100
• Fix any major bugs associated with static HTML generation (link to bugs in myst-theme)
• Light / dark mode does not persist between pages in static export myst-theme#319
• Social media card images from page metadata myst-theme#331
• Squishing and UI element overlapping on narrow screens #948
• Launch buttons for Binder and JupyterHub #1235

Operations

• Create a preview version of the new MyST backend for Jupyter Book