Template:Nixos:option/Doc

Revision as of 12:34, 10 February 2026 by Axka (talk | contribs) (Write new documentation for Template:nixos:option and add TemplateData)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Link to a NixOS option's page on https://search.nixos.org/options.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Option1

The attribute path of the option. Note that this template doesn't support including e.g. `<name>` in this parameter, but does in the "Display text" parameter.

Example
users.users.*.name
Stringrequired
Display text2

Alternative text to display

Default
The value of the "Option" parameter
Example
users.users.<name>.name
Stringoptional

Example

{{nixos:option|users.users.*.name|users.users.<name>.name}}

users.users.<name>.name