The following page describes changes to the MyST content that is served from the .json
endpoint of a MyST Site. The myst-migrate
package can be used to translate between versions by upgrading and downgrading between versions.
The version is a string integer (i.e. '1'
or '2'
) and is incremented with every change to the content of a MyST page, which includes metadata as well as the MyST AST.
MyST Versions¶
Version 3 — 2025-04-09¶
Output
nodes previously could not represent AST trees for each output.
Now, the Outputs
node has Output
children with a 1:1 correspondence to IOutput
bundles.
Existing identifiers for the Output
/ Outputs
nodes are not modified, as these are considered “content”.
Version 2 — 2025-03-05¶
Blocks could previously define class on block.data?.class
, this has been explicitly moved to block.class
.
Version 1 — 2025-02-07¶
Footnotes have dropped backwards compatibility with number
,
instead using enumerator
on both the FootnoteReference
and FootnoteDefinition
nodes.
Previous versions of the AST had both of these defined.
The enumerator
property is used in all other numberings of figures, sections, equations, etc.
Version 0 — before 2025-02-01¶
This is the first version of MyST AST considered to be versioned, subsequent releases will have changes for migrating the content between versions.