mystmd icon indicating copy to clipboard operation
mystmd copied to clipboard

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

Open agoose77 opened this issue 1 year ago • 2 comments
trafficstars

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

  • Sphinx uses orphan annotations in the frontmatter for this, so that files are parsed but not flagged for warnings because they aren't in the TOC
  • Original discussion thread

agoose77 avatar Nov 21 '24 10:11 agoose77