docutil_syntax_extensions.txt

[dollarmath] --myst-enable-extensions=dollarmath
.
$foo$

a $foo
bar$ b

$$foo$$

$$
a = 1
$$

$$
b = 2
$$ (label)
.
<document source="<string>">
    <paragraph>
        <math>
            foo
    <paragraph>
        a
        <math>
            foo
            bar
         b
    <math_block nowrap="False" number="True" xml:space="preserve">
        foo
    <math_block nowrap="False" number="True" xml:space="preserve">

        a = 1
    <math_block ids="label" names="label" nowrap="False" number="True" xml:space="preserve">

        b = 2
.

[amsmath] --myst-enable-extensions=amsmath
.
\begin{equation} a \end{equation}

\begin{equation}
a
\end{equation}

\begin{equation*}
a
\end{equation*}
.
<document source="<string>">
    <math_block classes="amsmath" nowrap="True" numbered="True" xml:space="preserve">
        \begin{equation} a \end{equation}
    <math_block classes="amsmath" nowrap="True" numbered="True" xml:space="preserve">
        \begin{equation}
        a
        \end{equation}
    <math_block classes="amsmath" nowrap="True" xml:space="preserve">
        \begin{equation*}
        a
        \end{equation*}
.

[deflist] --myst-enable-extensions=deflist
.
term
: definition
.
<document source="<string>">
    <definition_list classes="simple myst">
        <definition_list_item>
            <term>
                term
            <definition>
                <paragraph>
                    definition
.

[fieldlist] --myst-enable-extensions=fieldlist
.
:name: value
.
<document source="<string>">
    <docinfo>
        <field classes="name">
            <field_name>
                name
            <field_body>
                <paragraph>
                    value
.

[colon_fence] --myst-enable-extensions=colon_fence
.
:::{note}
content
:::
.
<document source="<string>">
    <note>
        <paragraph>
            content
.

[replacements] --myst-enable-extensions=replacements
.
(c) (C) (r) (R) (tm) (TM) (p) (P) +- ...
.
<document source="<string>">
    <paragraph>
        © © ® ® ™ ™ (p) (P) ± …
.

[strikethrough] --myst-enable-extensions=strikethrough
.
~~foo~~
.
<document source="<string>">
    <paragraph>
        <system_message level="2" line="1" source="<string>" type="WARNING">
            <paragraph>
                Strikethrough is currently only supported in HTML output [myst.strikethrough]
        <raw format="html" xml:space="preserve">
            <s>
        foo
        <raw format="html" xml:space="preserve">
            </s>
.

[strikethrough-single-tilde] --myst-enable-extensions=strikethrough --myst-strikethrough-single-tilde="true"
.
~foo~
.
<document source="<string>">
    <paragraph>
        <system_message level="2" line="1" source="<string>" type="WARNING">
            <paragraph>
                Strikethrough is currently only supported in HTML output [myst.strikethrough]
        <raw format="html" xml:space="preserve">
            <s>
        foo
        <raw format="html" xml:space="preserve">
            </s>
.

[tasklist-tight] --myst-enable-extensions=tasklist
.
- [ ] foo
- [x] bar
.
<document source="<string>">
    <bullet_list bullet="-" classes="contains-task-list">
        <list_item classes="task-list-item">
            <paragraph>
                <raw format="html" xml:space="preserve">
                    <input class="task-list-item-checkbox" disabled="disabled" type="checkbox">
                foo
        <list_item classes="task-list-item">
            <paragraph>
                <raw format="html" xml:space="preserve">
                    <input class="task-list-item-checkbox" checked="checked" disabled="disabled" type="checkbox">
                bar
.

[tasklist-loose] --myst-enable-extensions=tasklist
.
- [ ] loose foo

  extra paragraph

- [x] loose bar
.
<document source="<string>">
    <bullet_list bullet="-" classes="contains-task-list">
        <list_item classes="task-list-item">
            <paragraph>
                <raw format="html" xml:space="preserve">
                    <input class="task-list-item-checkbox" disabled="disabled" type="checkbox">
                loose foo
            <paragraph>
                extra paragraph
        <list_item classes="task-list-item">
            <paragraph>
                <raw format="html" xml:space="preserve">
                    <input class="task-list-item-checkbox" checked="checked" disabled="disabled" type="checkbox">
                loose bar
.

[alert-note] --myst-enable-extensions=alert
.
> [!NOTE]
> This is a note.
.
<document source="<string>">
    <note>
        <paragraph>
            This is a note.
.

[alert-tip] --myst-enable-extensions=alert
.
> [!TIP]
> This is a tip.
.
<document source="<string>">
    <tip>
        <paragraph>
            This is a tip.
.

[alert-important] --myst-enable-extensions=alert
.
> [!IMPORTANT]
> This is important.
.
<document source="<string>">
    <important>
        <paragraph>
            This is important.
.

[alert-warning] --myst-enable-extensions=alert
.
> [!WARNING]
> This is a warning.
.
<document source="<string>">
    <warning>
        <paragraph>
            This is a warning.
.

[alert-caution] --myst-enable-extensions=alert
.
> [!CAUTION]
> This is a caution.
.
<document source="<string>">
    <caution>
        <paragraph>
            This is a caution.
.

[alert-multiline] --myst-enable-extensions=alert
.
> [!NOTE]
> First paragraph.
>
> Second paragraph.
.
<document source="<string>">
    <note>
        <paragraph>
            First paragraph.
        <paragraph>
            Second paragraph.
.

[alert-code-fence] --myst-enable-extensions=alert
.
> [!NOTE]
> Note
>
> ```py
> "code"
> ```
>
> other
>
> ```py
> "other code"
> ```
.
<document source="<string>">
    <note>
        <paragraph>
            Note
        <literal_block classes="code py" xml:space="preserve">
            <inline classes="s2">
                "code"
        <paragraph>
            other
        <literal_block classes="code py" xml:space="preserve">
            <inline classes="s2">
                "other code"
.

[gfm_autolink] --myst-enable-extensions=gfm_autolink
.
Visit www.example.com for info.

Contact user@example.com for help.
.
<document source="<string>">
    <paragraph>
        Visit
        <reference refuri="http://www.example.com">
            www.example.com
         for info.
    <paragraph>
        Contact
        <reference refuri="mailto:user@example.com">
            user@example.com
         for help.
.