jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
217 stars 64 forks source link

Allow users to parse and include documents in their MyST build that aren't part of the table of contents #1666

Open agoose77 opened 1 day ago

agoose77 commented 1 day ago

It can be useful to have pages that define content (executable outputs, markdown snippets, etc) that are solely meant for re-use in a book, and aren't part of the book itself.

Right now, for a document's content to be available in a book (e.g. with {embed}) it must also be listed in the toc: and will show up in the sidebar.

Instead, there should be a way to get MyST to parse content even though it isn't meant for inclusion in the sidebar.

References

choldgraf commented 1 day ago

@agoose77 I cleaned up the issue body a bit so that it was clearer what kind of end-functionality we needed from a user's perspective