OFM block IDs · Comrak

Obsidian block IDs let a whole block be linked to from elsewhere. Append ^identifier to the end of a block’s last line, where the identifier is one or more ASCII letters, digits, or hyphens preceded by whitespace; the marker is removed from the rendered text, and the block gets an id attribute that includes the caret. See Link to a block in a note.

$ comrak -e ofm-block-ids -t commonmark -t xml

Some paragraph text ^37066d

<p id="^37066d">Some paragraph text </p>

Some paragraph text ^37066d

<?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">Some paragraph text </text>
    <block_id name="37066d" />
  </paragraph>
</document>

$ comrak -e ofm-block-ids -t commonmark -t xml

# Title ^hdr

<h1 id="^hdr">Title </h1>

# Title ^hdr

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <heading level="1">
    <text xml:space="preserve">Title </text>
    <block_id name="hdr" />
  </heading>
</document>

$ comrak -e ofm-block-ids -t commonmark -t xml

> A blockquote ^inside

<blockquote id="^inside">
<p>A blockquote </p>
</blockquote>

> A blockquote ^inside

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <block_quote>
    <paragraph>
      <text xml:space="preserve">A blockquote </text>
      <block_id name="inside" />
    </paragraph>
  </block_quote>
</document>

$ comrak -e ofm-block-ids -t commonmark -t xml

- a ^item
- b

<ul>
<li id="^item">a </li>
<li>b</li>
</ul>

- a ^item
- b

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <list type="bullet" tight="true">
    <item>
      <paragraph>
        <text xml:space="preserve">a </text>
        <block_id name="item" />
      </paragraph>
    </item>
    <item>
      <paragraph>
        <text xml:space="preserve">b</text>
      </paragraph>
    </item>
  </list>
</document>

$ comrak -e ofm-block-ids -e table -t commonmark -t xml

| A | B |
| - | - |
| x | y ^cell |

A	B
x	y

<table id="^cell">
<thead>
<tr>
<th>A</th>
<th>B</th>
</tr>
</thead>
<tbody>
<tr>
<td>x</td>
<td>y </td>
</tr>
</tbody>
</table>

| A | B |
| --- | --- |
| x | y ^cell |

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <table>
    <table_row>
      <table_cell>
        <text xml:space="preserve">A</text>
      </table_cell>
      <table_cell>
        <text xml:space="preserve">B</text>
      </table_cell>
    </table_row>
    <table_row>
      <table_cell>
        <text xml:space="preserve">x</text>
      </table_cell>
      <table_cell>
        <text xml:space="preserve">y </text>
        <block_id name="cell" />
      </table_cell>
    </table_row>
  </table>
</document>

$ comrak -e ofm-block-ids -t commonmark -t xml

one ^first
two ^second

<p id="^second">one ^first
two </p>

one \^first
two ^second

<?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">one ^first</text>
    <softbreak />
    <text xml:space="preserve">two </text>
    <block_id name="second" />
  </paragraph>
</document>