diff options
| author | David Warde-Farley <dwf@google.com> | 2022-09-26 03:00:16 +0100 |
|---|---|---|
| committer | Yt <happysalada@proton.me> | 2022-09-28 10:48:10 -0400 |
| commit | a81954b818177fc140ebf703572a486944e3187b (patch) | |
| tree | 58a02912934d512e0887848e64e7802a542fc3cf /nixos/modules/services/web-servers/caddy | |
| parent | c3e75d49314f262d8a9f15aa0070ea6c1794cd18 (diff) | |
Fix docs.
Diffstat (limited to 'nixos/modules/services/web-servers/caddy')
| -rw-r--r-- | nixos/modules/services/web-servers/caddy/default.nix | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/nixos/modules/services/web-servers/caddy/default.nix b/nixos/modules/services/web-servers/caddy/default.nix index d92fe698c5f61..e1456091717d4 100644 --- a/nixos/modules/services/web-servers/caddy/default.nix +++ b/nixos/modules/services/web-servers/caddy/default.nix @@ -159,26 +159,24 @@ in adapter = mkOption { default = null; - example = "nginx"; + example = literalExpression "nginx"; type = with types; nullOr str; - description = '' + description = lib.mdDoc '' Name of the config adapter to use. See <https://caddyserver.com/docs/config-adapters> for the full list. - If <literal>null</literal> is specified, the <literal>--adapter</literal> - argument is omitted when starting or restarting Caddy. Notably, this - allows specification of a configuration file in Caddy's native JSON - format, as long as the filename does not start with - <literal>Caddyfile</literal> (in which case the - <literal>caddyfile</literal> adapter is implicitly enabled). See - <link xlink:href="https://caddyserver.com/docs/command-line#caddy-run"/> - for details. + If `null` is specified, the `--adapter` argument is omitted when + starting or restarting Caddy. Notably, this allows specification of a + configuration file in Caddy's native JSON format, as long as the + filename does not start with `Caddyfile` (in which case the `caddyfile` + adapter is implicitly enabled). See + <https://caddyserver.com/docs/command-line#caddy-run> for details. - <note><para> - Any value other than <literal>null</literal> or <literal>caddyfile</literal> - is only valid when providing your own <option>configFile</option>. - </para></note> + ::: {.note} + Any value other than `null` or `caddyfile` is only valid when providing + your own `configFile`. + ::: ''; }; |