Merge pull request #240754 from SuperSandro2000/ssh-fix-manpage

nixos/{sshd,thelounge,ttyd,proxmox-image}: fix example rendering
This commit is contained in:
pennae 2023-06-30 20:24:43 +02:00 committed by GitHub
commit 05b84a2b83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 21 deletions

View file

@ -279,10 +279,12 @@ in
settings = mkOption {
description = lib.mdDoc "Configuration for `sshd_config(5)`.";
default = { };
example = literalExpression ''{
UseDns = true;
PasswordAuthentication = false;
}'';
example = literalExpression ''
{
UseDns = true;
PasswordAuthentication = false;
}
'';
type = types.submodule ({name, ...}: {
freeformType = settingsFormat.type;
options = {

View file

@ -48,14 +48,16 @@ in
extraConfig = mkOption {
default = { };
type = types.attrs;
example = literalExpression ''{
reverseProxy = true;
defaults = {
name = "Your Network";
host = "localhost";
port = 6697;
};
}'';
example = literalExpression ''
{
reverseProxy = true;
defaults = {
name = "Your Network";
host = "localhost";
port = 6697;
};
}
'';
description = lib.mdDoc ''
The Lounge's {file}`config.js` contents as attribute set (will be
converted to JSON to generate the configuration file).

View file

@ -78,11 +78,12 @@ in
clientOptions = mkOption {
type = types.attrsOf types.str;
default = {};
example = literalExpression ''{
fontSize = "16";
fontFamily = "Fira Code";
}'';
example = literalExpression ''
{
fontSize = "16";
fontFamily = "Fira Code";
}
'';
description = lib.mdDoc ''
Attribute set of client options for xtermjs.
<https://xtermjs.org/docs/api/terminal/interfaces/iterminaloptions/>

View file

@ -98,10 +98,12 @@ with lib;
qemuExtraConf = mkOption {
type = with types; attrsOf (oneOf [ str int ]);
default = {};
example = literalExpression ''{
cpu = "host";
onboot = 1;
}'';
example = literalExpression ''
{
cpu = "host";
onboot = 1;
}
'';
description = lib.mdDoc ''
Additional options appended to qemu-server.conf
'';