Footnotes · Comrak

$ comrak -e footnotes -t commonmark -t xml

Hi[^x].

[^x]: A greeting.

<p>Hi<sup class="footnote-ref"><a href="#fn-x" id="fnref-x" data-footnote-ref>1</a></sup>.</p>
<section class="footnotes" data-footnotes>
<ol>
<li id="fn-x">
<p>A greeting. <a href="#fnref-x" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1" aria-label="Back to reference 1">↩</a></p>
</li>
</ol>
</section>

Hi[^x].

[^x]:
    A greeting.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <text xml:space="preserve">Hi</text>
    <footnote_reference label="x" />
    <text xml:space="preserve">.</text>
  </paragraph>
  <footnote_definition label="x">
    <paragraph>
      <text xml:space="preserve">A greeting.</text>
    </paragraph>
  </footnote_definition>
</document>

$ comrak -e footnotes -t commonmark -t xml

Here is a[^nowhere] footnote reference,[^1] and another.[^longnote]

This is another note.[^note] And footnote[^longnote] is referenced again.

[^note]: Hi.

[^1]: Here is the footnote.

[^longnote]: Here's one with multiple blocks.

    Subsequent paragraphs are indented.

        code

This is regular content.

[^unused]: This is not used.

<p>Here is a[^nowhere] footnote reference,<sup class="footnote-ref"><a href="#fn-1" id="fnref-1" data-footnote-ref>1</a></sup> and another.<sup class="footnote-ref"><a href="#fn-longnote" id="fnref-longnote" data-footnote-ref>2</a></sup></p>
<p>This is another note.<sup class="footnote-ref"><a href="#fn-note" id="fnref-note" data-footnote-ref>3</a></sup> And footnote<sup class="footnote-ref"><a href="#fn-longnote" id="fnref-longnote-2" data-footnote-ref>2</a></sup> is referenced again.</p>
<p>This is regular content.</p>
<section class="footnotes" data-footnotes>
<ol>
<li id="fn-1">
<p>Here is the footnote. <a href="#fnref-1" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1" aria-label="Back to reference 1">↩</a></p>
</li>
<li id="fn-longnote">
<p>Here's one with multiple blocks.</p>
<p>Subsequent paragraphs are indented.</p>
<pre class="syntax-highlighting"><code><span class="text plain">code
</span></code></pre>
<a href="#fnref-longnote" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="2" aria-label="Back to reference 2">↩</a> <a href="#fnref-longnote-2" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="2-2" aria-label="Back to reference 2-2">↩<sup class="footnote-ref">2</sup></a>
</li>
<li id="fn-note">
<p>Hi. <a href="#fnref-note" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="3" aria-label="Back to reference 3">↩</a></p>
</li>
</ol>
</section>

Here is a\[^nowhere\] footnote reference,[^1] and another.[^longnote]

This is another note.[^note] And footnote[^longnote] is referenced again.

This is regular content.

[^1]:
    Here is the footnote.

[^longnote]:
    Here's one with multiple blocks.
    
    Subsequent paragraphs are indented.
    
        code

[^note]:
    Hi.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <text xml:space="preserve">Here is a[^nowhere] footnote reference,</text>
    <footnote_reference label="1" />
    <text xml:space="preserve"> and another.</text>
    <footnote_reference label="longnote" />
  </paragraph>
  <paragraph>
    <text xml:space="preserve">This is another note.</text>
    <footnote_reference label="note" />
    <text xml:space="preserve"> And footnote</text>
    <footnote_reference label="longnote" />
    <text xml:space="preserve"> is referenced again.</text>
  </paragraph>
  <paragraph>
    <text xml:space="preserve">This is regular content.</text>
  </paragraph>
  <footnote_definition label="1">
    <paragraph>
      <text xml:space="preserve">Here is the footnote.</text>
    </paragraph>
  </footnote_definition>
  <footnote_definition label="longnote">
    <paragraph>
      <text xml:space="preserve">Here's one with multiple blocks.</text>
    </paragraph>
    <paragraph>
      <text xml:space="preserve">Subsequent paragraphs are indented.</text>
    </paragraph>
    <code_block xml:space="preserve">code
</code_block>
  </footnote_definition>
  <footnote_definition label="note">
    <paragraph>
      <text xml:space="preserve">Hi.</text>
    </paragraph>
  </footnote_definition>
</document>

$ comrak -e footnotes -t commonmark -t xml

Here is a footnote reference.[^AB] and [^ab]

[^aB]: Here is the footnote.

<p>Here is a footnote reference.<sup class="footnote-ref"><a href="#fn-aB" id="fnref-aB" data-footnote-ref>1</a></sup> and <sup class="footnote-ref"><a href="#fn-aB" id="fnref-aB-2" data-footnote-ref>1</a></sup></p>
<section class="footnotes" data-footnotes>
<ol>
<li id="fn-aB">
<p>Here is the footnote. <a href="#fnref-aB" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1" aria-label="Back to reference 1">↩</a> <a href="#fnref-aB-2" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1-2" aria-label="Back to reference 1-2">↩<sup class="footnote-ref">2</sup></a></p>
</li>
</ol>
</section>

Here is a footnote reference.[^aB] and [^aB]

[^aB]:
    Here is the footnote.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <text xml:space="preserve">Here is a footnote reference.</text>
    <footnote_reference label="aB" />
    <text xml:space="preserve"> and </text>
    <footnote_reference label="aB" />
  </paragraph>
  <footnote_definition label="aB">
    <paragraph>
      <text xml:space="preserve">Here is the footnote.</text>
    </paragraph>
  </footnote_definition>
</document>

$ comrak -e footnotes -t commonmark -t xml

Here is a footnote reference.[^😄ref]

[^😄ref]: Here is the footnote.

<p>Here is a footnote reference.<sup class="footnote-ref"><a href="#fn-%F0%9F%98%84ref" id="fnref-%F0%9F%98%84ref" data-footnote-ref>1</a></sup></p>
<section class="footnotes" data-footnotes>
<ol>
<li id="fn-%F0%9F%98%84ref">
<p>Here is the footnote. <a href="#fnref-%F0%9F%98%84ref" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1" aria-label="Back to reference 1">↩</a></p>
</li>
</ol>
</section>

Here is a footnote reference.[^😄ref]

[^😄ref]:
    Here is the footnote.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <text xml:space="preserve">Here is a footnote reference.</text>
    <footnote_reference label="😄ref" />
  </paragraph>
  <footnote_definition label="😄ref">
    <paragraph>
      <text xml:space="preserve">Here is the footnote.</text>
    </paragraph>
  </footnote_definition>
</document>

$ comrak -e footnotes -t commonmark -t xml

Foo.[^one two]

[^one two]: Here is the footnote.

<p>Foo.[^one two]</p>
<p>[^one two]: Here is the footnote.</p>

Foo.\[^one two\]

\[^one two\]: Here is the footnote.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <text xml:space="preserve">Foo.[^one two]</text>
  </paragraph>
  <paragraph>
    <text xml:space="preserve">[^one two]: Here is the footnote.</text>
  </paragraph>
</document>

$ comrak -e footnotes -e table -t commonmark -t xml

A footnote in a paragraph[^1]

| Column1   | Column2 |
| --------- | ------- |
| foot [^1] | note    |

[^1]: a footnote

Column1	Column2
foot ¹	note

<p>A footnote in a paragraph<sup class="footnote-ref"><a href="#fn-1" id="fnref-1" data-footnote-ref>1</a></sup></p>
<table>
<thead>
<tr>
<th>Column1</th>
<th>Column2</th>
</tr>
</thead>
<tbody>
<tr>
<td>foot <sup class="footnote-ref"><a href="#fn-1" id="fnref-1-2" data-footnote-ref>1</a></sup></td>
<td>note</td>
</tr>
</tbody>
</table>
<section class="footnotes" data-footnotes>
<ol>
<li id="fn-1">
<p>a footnote <a href="#fnref-1" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1" aria-label="Back to reference 1">↩</a> <a href="#fnref-1-2" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1-2" aria-label="Back to reference 1-2">↩<sup class="footnote-ref">2</sup></a></p>
</li>
</ol>
</section>

A footnote in a paragraph[^1]

| Column1 | Column2 |
| --- | --- |
| foot [^1] | note |

[^1]:
    a footnote

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <text xml:space="preserve">A footnote in a paragraph</text>
    <footnote_reference label="1" />
  </paragraph>
  <table>
    <table_row>
      <table_cell>
        <text xml:space="preserve">Column1</text>
      </table_cell>
      <table_cell>
        <text xml:space="preserve">Column2</text>
      </table_cell>
    </table_row>
    <table_row>
      <table_cell>
        <text xml:space="preserve">foot </text>
        <footnote_reference label="1" />
      </table_cell>
      <table_cell>
        <text xml:space="preserve">note</text>
      </table_cell>
    </table_row>
  </table>
  <footnote_definition label="1">
    <paragraph>
      <text xml:space="preserve">a footnote</text>
    </paragraph>
  </footnote_definition>
</document>

$ comrak -e footnotes -e superscript -t commonmark -t xml

Here is a footnote reference.[^1]

Here is a longer footnote reference.[^ref]

e = mc^2^.

[^1]: Here is the footnote.
[^ref]: Here is another footnote.

<p>Here is a footnote reference.<sup class="footnote-ref"><a href="#fn-1" id="fnref-1" data-footnote-ref>1</a></sup></p>
<p>Here is a longer footnote reference.<sup class="footnote-ref"><a href="#fn-ref" id="fnref-ref" data-footnote-ref>2</a></sup></p>
<p>e = mc<sup>2</sup>.</p>
<section class="footnotes" data-footnotes>
<ol>
<li id="fn-1">
<p>Here is the footnote. <a href="#fnref-1" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="1" aria-label="Back to reference 1">↩</a></p>
</li>
<li id="fn-ref">
<p>Here is another footnote. <a href="#fnref-ref" class="footnote-backref" data-footnote-backref data-footnote-backref-idx="2" aria-label="Back to reference 2">↩</a></p>
</li>
</ol>
</section>

Here is a footnote reference.[^1]

Here is a longer footnote reference.[^ref]

e = mc^2^.

[^1]:
    Here is the footnote.

[^ref]:
    Here is another footnote.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <text xml:space="preserve">Here is a footnote reference.</text>
    <footnote_reference label="1" />
  </paragraph>
  <paragraph>
    <text xml:space="preserve">Here is a longer footnote reference.</text>
    <footnote_reference label="ref" />
  </paragraph>
  <paragraph>
    <text xml:space="preserve">e = mc</text>
    <superscript>
      <text xml:space="preserve">2</text>
    </superscript>
    <text xml:space="preserve">.</text>
  </paragraph>
  <footnote_definition label="1">
    <paragraph>
      <text xml:space="preserve">Here is the footnote.</text>
    </paragraph>
  </footnote_definition>
  <footnote_definition label="ref">
    <paragraph>
      <text xml:space="preserve">Here is another footnote.</text>
    </paragraph>
  </footnote_definition>
</document>