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
14[nav]
15# Explicit, because the header already links home: listing index.org here as well would
16# repeat the site title in the nav directly beside itself. The guide reaches the nav as a
17# collection below, since it lives in a subdirectory rather than at the top level.
18mode = "explicit"
19pages = ["install.org", "quickstart.org"]
20
21[templates]
22dir = "templates"
23
24[highlight]
25# A dark theme, with code blocks styled dark in both colour schemes. syntax.css is
26# generated from a single syntect theme and cannot respond to prefers-color-scheme, so
27# the page CSS matches the theme rather than leaving code unreadable in one of them.
28theme = "base16-ocean.dark"
29
30[html]
31# The layout renders the page title as <h1>, so document headings start at <h2>.
32heading_offset = 1
33toc = true
34section_numbers = false
35
36# The guide's contents page, listing every chapter in reading order rather than by date.
37[[collections]]
38source = "guide"
39output = "guide/index.html"
40template = "list.html"
41title = "Guide"
42sort = "path"
43order = "asc"
44nav = true