myst-spec

cases: - title: Invalid figure reference without value mdast: type: root children: - type: paragraph children: - type: mystRole name: numref value: my-figure children: - type: crossReference kind: numref identifier: my-figure label: my-figure myst: |- {numref}`my-figure` html: |- <code class="kind">{numref}</code><code>my-figure</code> - title: Invalid figure reference mdast: type: root children: - type: paragraph children: - type: mystRole name: numref value: Figure %s <my-figure> children: - type: crossReference kind: numref identifier: my-figure label: my-figure children: - type: text value: Figure %s myst: |- {numref}`Figure %s <my-figure>` html: |- <code class="kind">{numref}</code><code>my-figure</code> - title: Invalid figure reference with messy label mdast: type: root children: - type: paragraph children: - type: mystRole name: numref value: Figure %s < My - Figure > children: - type: crossReference kind: numref identifier: my - figure label: ' My - Figure ' children: - type: text value: Figure %s myst: |- {numref}`Figure %s < My - Figure >` html: |- <code class="kind">{numref}</code><code>my - figure</code> - title: Figure reference with default numref mdast: type: root children: - type: paragraph children: - type: text value: 'see ' - type: mystRole name: numref value: my-figure children: - type: crossReference kind: numref identifier: my-figure label: my-figure - type: mystDirective name: figure args: fig.jpg options: name: my-figure value: Cool caption! children: - type: container kind: figure identifier: my-figure label: my-figure children: - type: image url: fig.jpg - type: caption children: - type: paragraph children: - type: text value: Cool caption! myst: |- see {numref}`my-figure` ```{figure} fig.jpg :name: my-figure Cool caption! ``` html: |- see <a href="#my-figure">Figure 1</a> <figure id="my-figure" class="numbered"> <img src="fig.jpg"> <figcaption> Figure 1Cool caption! </figcaption> </figure> - title: Figure reference with custom numref mdast: type: root children: - type: paragraph children: - type: text value: 'see ' - type: mystRole name: numref value: Figure %s%s%s, I said {number}<my-figure> children: - type: crossReference kind: numref identifier: my-figure label: my-figure children: - type: text value: Figure %s%s%s, I said {number} - type: mystDirective name: figure args: fig.jpg options: name: my-figure value: Cool caption! children: - type: container kind: figure identifier: my-figure label: my-figure children: - type: image url: fig.jpg - type: caption children: - type: paragraph children: - type: text value: Cool caption! myst: |- see {numref}`Figure %s%s%s, I said {number}<my-figure>` ```{figure} fig.jpg :name: my-figure Cool caption! ``` html: |- see <a href="#my-figure">Figure 111, I said 1</a> <figure id="my-figure" class="numbered"> <img src="fig.jpg"> <figcaption> Figure 1Cool caption! </figcaption> </figure> - title: Figure reference with default ref mdast: type: root children: - type: paragraph children: - type: text value: 'see ' - type: mystRole name: ref value: my-figure children: - type: crossReference kind: ref identifier: my-figure label: my-figure - type: mystDirective name: figure args: fig.jpg options: name: my-figure value: Cool *caption*! children: - type: container kind: figure identifier: my-figure label: my-figure children: - type: image url: fig.jpg - type: caption children: - type: paragraph children: - type: text value: 'Cool ' - type: emphasis children: - type: text value: caption - type: text value: '!' myst: |- see {ref}`my-figure` ```{figure} fig.jpg :name: my-figure Cool *caption*! ``` html: |- see <a href="#my-figure">Cool caption!</a> <figure id="my-figure" class="numbered"> <img src="fig.jpg"> <figcaption> Figure 1Cool caption! </figcaption> </figure> - title: Figure reference with custom ref mdast: type: root children: - type: paragraph children: - type: text value: 'see ' - type: mystRole name: ref value: Custom *caption* <my-figure> children: - type: crossReference kind: ref identifier: my-figure label: my-figure children: - type: text value: Custom *caption* - type: mystDirective name: figure args: fig.jpg options: name: my-figure value: Cool *caption*! children: - type: container kind: figure identifier: my-figure label: my-figure children: - type: image url: fig.jpg - type: caption children: - type: paragraph children: - type: text value: 'Cool ' - type: emphasis children: - type: text value: caption - type: text value: '!' myst: |- see {ref}`Custom *caption* <my-figure>` ```{figure} fig.jpg :name: my-figure Cool *caption*! ``` html: |- see <a href="#my-figure">Custom *caption*</a> <figure id="my-figure" class="numbered"> <img src="fig.jpg"> <figcaption> Figure 1Cool caption! </figcaption> </figure> - title: Link-style figure reference with default ref mdast: type: root children: - type: paragraph children: - type: text value: 'see ' - type: link url: my-figure title: Figure title children: [] - type: mystDirective name: figure args: fig.jpg options: name: my-figure value: Cool *caption*! children: - type: container kind: figure identifier: my-figure label: my-figure children: - type: image url: fig.jpg - type: caption children: - type: paragraph children: - type: text value: 'Cool ' - type: emphasis children: - type: text value: caption - type: text value: '!' myst: |- see [](my-figure "Figure title") ```{figure} fig.jpg :name: my-figure Cool *caption*! ``` html: |- see <a href="#my-figure" title="Figure title">Cool caption!</a> <figure id="my-figure" class="numbered"> <img src="fig.jpg"> <figcaption> Figure 1Cool caption! </figcaption> </figure> - title: Link-style figure reference with custom ref mdast: type: root children: - type: paragraph children: - type: text value: 'see ' - type: link url: my-figure children: - type: text value: 'Custom ' - type: emphasis children: - type: text value: caption - type: mystDirective name: figure args: fig.jpg options: name: my-figure value: Cool *caption*! children: - type: container kind: figure identifier: my-figure label: my-figure children: - type: image url: fig.jpg - type: caption children: - type: paragraph children: - type: text value: 'Cool ' - type: emphasis children: - type: text value: caption - type: text value: '!' myst: |- see [Custom *caption*](my-figure) ```{figure} fig.jpg :name: my-figure Cool *caption*! ``` html: |- see <a href="#my-figure">Custom caption</a> <figure id="my-figure" class="numbered"> <img src="fig.jpg"> <figcaption> Figure 1Cool caption! </figcaption> </figure>