Options
docs
Specify multiple docs by specifying them in an attrset
Type:
attribute set of (submodule)
Default value:
{ }
Declared in:
docs.<name>.base
Base path of the repo (parent dir of the dir specified in path)
Type:
string or absolute path
Default value:
""
Declared in:
docs.<name>.config
Configuration which gets passed to mkdocs
Type:
attribute set
Default value:
{ }
Declared in:
docs.<name>.deps
Dependencies needed to build the docs
Type:
function that evaluates to a(n) list of package
Default value:
p: []
Declared in:
docs.<name>.macros.enable
Whether to enable mkdocs-macros.
Type:
boolean
Default value:
false
Example value:
true
Declared in:
docs.<name>.macros.includeDir
Which directory to load includes from. Can be a store path aswell, this allows you to generate stuff with Nix and include it, even when using the watch mode (but it won't update if it's a store path, so it's only generated once when running the watcher).
Type:
null or string
Default value:
null
Declared in:
docs.<name>.material.colors.accent
Accent color.
Type:
string
Default value:
"aqua"
Declared in:
docs.<name>.material.colors.primary
Primary color.
Type:
string
Default value:
"blue"
Declared in:
docs.<name>.material.enable
Whether to enable mkdocs-material.
Type:
boolean
Default value:
false
Example value:
true
Declared in:
docs.<name>.material.umami.domains
List of domains where the tracking should activate. This makes it possible to have staging envs or whatever, without Umami tracking stuff.
Type:
list of string
Default value:
[ ]
Declared in:
docs.<name>.material.umami.enable
Whether to enable material-umami.
Type:
boolean
Default value:
false
Example value:
true
Declared in:
docs.<name>.material.umami.enableFeedback
Whether to enable the "Feedback" widget at the bottom of a page.
Type:
boolean
Default value:
true
Declared in:
docs.<name>.material.umami.siteId
The site ID from Umami, can be found in the dashboard's URL for example.
Type:
string
Example value:
"6f7d66a1-392f-49db-b0d5-fca931724f2d"
Declared in:
docs.<name>.material.umami.src
The URL where the tracking script is loaded from.
Type:
string
Example value:
"https://analytics.example.com/umami"
Declared in:
docs.<name>.path
Path to the docs
Type:
string or absolute path
Default value:
""
Declared in: