Setting up

Build and run the viewer from the repository root:

make run

Then open http://localhost:8080/. To serve a different directory or port:

make run DATA=/path/to/notes ADDR=:9000

How URLs map to files

URL File
/ index.md
/guides/ guides/index.md
/guides/setup.md guides/setup.md
/img/diagram.svg img/diagram.svg

Request flow

Next: Writing pages