krz/orgo

 1# Configuration for the orgo documentation site.
 2#
 3# This site is built by orgo itself, so this file doubles as a worked example: every
 4# setting here is one the docs describe, used the way the docs recommend.
 5
 6[site]
 7title = "orgo"
 8description = "An org-mode static site generator, in Rust."
 9language = "en"
10# Left empty so the docs build with relative URLs and open from the filesystem. Set it to
11# your real origin to enable canonical links and feeds.
12base_url = ""
13# The built-in theme written for exactly this: a guide read in order, with a contents
14# block that matters. The site's own CSS is six lines of overrides on top of it.
15theme = "docs"
16
17[nav]
18# Explicit, because the header already links home: listing index.org here as well would
19# repeat the site title in the nav directly beside itself. The guide reaches the nav as a
20# collection below, since it lives in a subdirectory rather than at the top level.
21mode = "explicit"
22pages = ["install.org", "quickstart.org"]
23
24[templates]
25dir = "templates"
26
27[highlight]
28# A dark theme, with code blocks styled dark in both colour schemes. syntax.css is
29# generated from a single syntect theme and cannot respond to prefers-color-scheme, so
30# the page CSS matches the theme rather than leaving code unreadable in one of them.
31# That match is style.css, which overrides the site theme's --orgo-code-* properties and
32# nothing else — the documented way to adjust a built-in theme instead of replacing it.
33theme = "base16-ocean.dark"
34
35[html]
36# The layout renders the page title as <h1>, so document headings start at <h2>.
37heading_offset = 1
38toc = true
39section_numbers = false
40
41# The guide's contents page, listing every chapter in reading order rather than by date.
42[[collections]]
43source = "guide"
44output = "guide/index.html"
45template = "list.html"
46title = "Guide"
47sort = "path"
48order = "asc"
49nav = true