Org Notes

Contents

Org files follow org-roam conventions, so notes written in Emacs with org-roam publish here without modification.

Anatomy of an org note 

:PROPERTIES:
:ID: 00000000-1111-2222-3333-444444444444
:END:
#+title: My Note

Body text, with a link to [[id:some-other-uuid][another note]].

* A heading
  • The file-level :PROPERTIES: drawer holds the org-roam :ID:. The generator indexes it so other notes can link here by id.
  • #+title: becomes the page's <h1> and the title shown in backlinks on other pages.

Links

Three link styles resolve to other notes (see Linking for how they feed backlinks):

  • [[id:<uuid>][description]] – org-roam id links, resolved against every note's :ID: property. Links to unknown ids are left as-is and a warning is printed at build time.
  • [[file:page.org][description]] – plain org file links.
  • [[page.org]] or [[page.md]] – bare file links; the filename is used as the link text.

Org notes can link to markdown notes and vice versa – the target is always resolved to the note's slug.

Raw HTML

Unlike markdown, org escapes bare HTML. To embed Widgets or any other markup, use an export block:

#+begin_export html
<slide-show src="/static/example-slideshow.md" theme="dark"></slide-show>
#+end_export

or a one-liner: #+html: <badge-example></badge-example>. This matches what Emacs's own HTML exporter does.

Backlinks