Install

ostat needs two things on your machine: the Odin compiler and libcmark, which the vendor:commonmark bindings link against.

brew install cmark          # macOS
sudo apt install libcmark-dev   # Debian, Ubuntu

build.sh looks for the library in /opt/homebrew/lib and /usr/local/lib and passes the path to the linkerIf the link fails with library not found for -lcmark on macOS, or cannot find -lcmark on Linux, cmark is not installed. If it is installed somewhere else entirely, add the directory to the loop in build.sh.. On Linux it usually finds nothing, which is correct: the library is already where the linker looks.

Building

./build.sh          # debug build, into build/debug/ostat
./build.sh release  # optimised
./build.sh test     # every @(test) proc

./dev builds this documentation site and serves it on port 1313. It needs python3 for the server; nothing else does.

./dev               # build with drafts, serve
./dev --build       # build without drafts, no server
./dev --clean       # discard the output tree first, then serve

Building a site

ostat build [site-dir]      build a site into an output directory
ostat new <path>            create a page from the archetype
ostat version               print the version

Build options:

A site directory holds content/, and optionally static/ which is copied into the output verbatim.

site/
  content/
    install.md         -> /install/
    blog/
      _index.md        -> /blog/          the section page
      0-1-0.md         -> /blog/0-1-0/
  static/
    css/style.css      -> /css/style.css

A file named _index.md is its directory’s section page. Any other .md file is a regular page. The home page has no file at all: it is the configuration plus the most recent posts.

Alongside the pages a build writes sitemap.xml and two identical feeds, /index.xml and /blog/index.xml, so either address works in a reader.