Below are some opinionated “rules” for writing consistent notes while accommodating the idiosyncrasies of our static site generator.
Headers
Start sections with an ##
i.e., an <h2>
. The <h1>
is reserved for the title and is automatically generated from the note metadata.
Links
Link between notes as much as practical. Links to other notes are made with
Look at [Clim-Clam]({{< ref "/notes/clim-clam" >}} "alt-text")!
where the note path is relative to the content
directory.
Linking images is done differently:
Look at ![a picture of Orson](/img/welles/orson.png "alt-text")!
Notably, the image path is relative to the static
directory.