jupyter-book / mystmd

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

Better UX around multiple versions of MyST on hosted servers #1458

Open choldgraf opened 3 months ago

choldgraf commented 3 months ago

Some communities want to version their documentation over time, or because their docs are attached to releases of software packages.

For example, people are asking if there is a "version dropdown" support similar to the version dropdowns in the PyData theme.

They'd also like announcement functionality to be able to point users to newer versions of documentation.

Currently, there's no "recommended" way of doing this, and so people are confused about whether they should use readthedocs for this, hack their own GitHub Action, etc.

It would be helpful if we can at least document a recommended way to achieve this workflow, and ideally think about any functionality we can build into MyST to make this easier to accomplish.

Related