Skip to main content

Module config

Module config 

Source
Expand description

asbuilt.toml: the release it is written for, the output path, the externals nothing static in the code can state, and every front-end’s own table kept raw for it to parse.

Structs§

Config
The parsed asbuilt.toml.
DocsConfig
What asbuilt docs cannot read off the code.
External
Something outside the code that a module talks to: a spawned process, a browser, a service. Nothing static says it exists, so the config does.
ExternalRelation
An edge from a generated element (or another external) to this one.
OutputConfig
ThemeColor
A kind’s color: one value for every scheme, or a light and a dark one. Written as "#3b82f6" or { light = "#3b82f6", dark = "#1e40af" }. Parsed by hand rather than as an untagged enum, whose only error is “did not match any variant”: a mistake here names the key or value.

Enums§

ColorScheme
The color scheme the documentation pages show before a visitor chooses one: the system’s setting, or light or dark regardless of it.

Constants§

DEFAULT_OUTPUT_PATH
Where survey writes and check reads when the config says nothing.
FILE_NAME
The config file name, looked up at the surveyed root.
PIN_KEY
The top-level key that pins the asbuilt release a config is written for: asbuilt = "0.3.0".

Functions§

is_hex_color
#rrggbb, six hex digits after the #.