Writing Notes

Contents

Notes live in the notes/ directory. It's flat – no sub directories – and every file becomes a page.

File formats

Extension Handling
.md Rendered with goldmark (GFM: tables, task lists, strikethrough). Raw HTML passes through.
.org Rendered with go-org, following org-roam conventions – see Org Notes.
.html Copied verbatim as a standalone page.

Slugs and URLs

A note's URL comes from its filename: strip the extension, lowercase it, and replace spaces with underscores. So Spaced Repetition.md and spaced_repetition.org both publish at /notes/spaced_repetition/.

The slug is also the note's node id in the Graph.

Structure within a note

  • In markdown, start with a # Heading – it becomes the page's <h1>.
  • In org, set #+title: instead; it renders as the <h1> and your top-level * headings become <h2>.
  • A table of contents is generated from the second- and third-level headings of either format.

Everything is also plain text

The generator concatenates every note into /all-notes.txt, handy for feeding the whole brain to a search tool or an LLM.

Backlinks