From 84df8a9161ccf6ec083d65006620a13483069b79 Mon Sep 17 00:00:00 2001 From: yunfachi Date: Wed, 9 Oct 2024 12:51:57 +0300 Subject: [PATCH] docs/src: fix arguments and style in nix codeblocks --- docs/src/hosts/examples.md | 4 ++++ docs/src/hosts/introduction.md | 1 + docs/src/modules/examples.md | 8 ++++++++ docs/src/modules/introduction-nixos.md | 2 +- docs/src/modules/introduction.md | 9 +++++---- docs/src/rices/examples.md | 2 ++ docs/src/rices/introduction.md | 4 ++++ docs/src/ru/hosts/examples.md | 4 ++++ docs/src/ru/hosts/introduction.md | 1 + docs/src/ru/modules/examples.md | 8 ++++++++ docs/src/ru/modules/introduction-nixos.md | 3 ++- docs/src/ru/modules/introduction.md | 9 +++++---- docs/src/ru/rices/examples.md | 2 ++ docs/src/ru/rices/introduction.md | 4 ++++ 14 files changed, 51 insertions(+), 10 deletions(-) diff --git a/docs/src/hosts/examples.md b/docs/src/hosts/examples.md index 673bcee..0eb57fc 100644 --- a/docs/src/hosts/examples.md +++ b/docs/src/hosts/examples.md @@ -4,6 +4,7 @@ An example of a minimal host module configuration that serves as a baseline for all further settings: ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -26,6 +27,7 @@ delib.module { The `type` option **is very** useful for default values in your modules. For example, the option `enable = boolOption host.isDesktop` can be used for some GUI programs. This simplifies configuration management based on the type of device. ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -55,6 +57,7 @@ delib.module { This option can be useful for configuring monitors; however, it can be implemented as a separate module. ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -96,6 +99,7 @@ delib.module { Using `delib.hostNamesAssertions` is strongly recommended, but it can also be omitted. ```nix +{delib, ...}: delib.module { name = "hosts"; diff --git a/docs/src/hosts/introduction.md b/docs/src/hosts/introduction.md index cfc3b11..d9818f9 100644 --- a/docs/src/hosts/introduction.md +++ b/docs/src/hosts/introduction.md @@ -11,6 +11,7 @@ For hosts to work, the configuration must include the options `${myconfigName}.h Here is an example of a minimal recommended host configuration: ```nix +{delib, ...}: delib.module { name = "hosts"; diff --git a/docs/src/modules/examples.md b/docs/src/modules/examples.md index d1e1017..eefbb1d 100644 --- a/docs/src/modules/examples.md +++ b/docs/src/modules/examples.md @@ -2,6 +2,7 @@ ## Constants {#constants} ```nix +{delib, ...}: delib.module { name = "constants"; @@ -16,6 +17,7 @@ delib.module { ## Hosts {#hosts} Without `type` option: ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -35,6 +37,7 @@ delib.module { ``` With `type` option: ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -62,6 +65,7 @@ delib.module { ## Rices {#rices} ```nix +{delib, ...}: delib.module { name = "rices"; @@ -83,6 +87,7 @@ delib.module { ## Home Manager {#home-manager} With [constants](#constants): ```nix +{delib, ...}: delib.module { name = "home"; @@ -100,6 +105,7 @@ delib.module { ## User {#user} With [constants](#constants): ```nix +{delib, ...}: delib.module { name = "user"; @@ -120,6 +126,7 @@ delib.module { ## Git {#git} With [constants](#constants): ```nix +{delib, ...}: delib.module { name = "programs.git"; @@ -140,6 +147,7 @@ delib.module { ## Alejandra {#alejandra} ```nix +{delib, ...}: delib.module { name = "programs.alejandra"; diff --git a/docs/src/modules/introduction-nixos.md b/docs/src/modules/introduction-nixos.md index 20ecab1..178f4c8 100644 --- a/docs/src/modules/introduction-nixos.md +++ b/docs/src/modules/introduction-nixos.md @@ -86,7 +86,7 @@ Denix uses a different approach to options, although both methods can be used si An example of a module with options using Denix: ```nix -{denix, ...}: +{delib, ...}: delib.module { name = "coolmodule"; diff --git a/docs/src/modules/introduction.md b/docs/src/modules/introduction.md index f7153c1..3633b45 100644 --- a/docs/src/modules/introduction.md +++ b/docs/src/modules/introduction.md @@ -6,17 +6,18 @@ This means that you can use all three types of modules simultaneously, although ### Denix Module ```nix -{delib, ...}: delib.module { +{delib, ...}: +delib.module { name = "..."; } ``` ### Denix Module with NixOS/Home Manager Module ```nix -{delib, ...}: delib.module { +{delib, ...}: +delib.module { name = "..."; -} -// { +} // { } ``` diff --git a/docs/src/rices/examples.md b/docs/src/rices/examples.md index 59e6e6f..754abca 100644 --- a/docs/src/rices/examples.md +++ b/docs/src/rices/examples.md @@ -4,6 +4,7 @@ An example of a minimal rice module configuration that serves as a baseline for all further settings: ```nix +{delib, ...}: delib.module { name = "rices"; @@ -26,6 +27,7 @@ delib.module { Using `delib.riceNamesAssertions` is strongly recommended, but it can also be omitted. ```nix +{delib, ...}: delib.module { name = "rices"; diff --git a/docs/src/rices/introduction.md b/docs/src/rices/introduction.md index a6bced9..1499873 100644 --- a/docs/src/rices/introduction.md +++ b/docs/src/rices/introduction.md @@ -11,6 +11,7 @@ A rice can inherit all configurations of another rice via the `inherits` attribu Example of three rices, where the first two inherit all configurations from the "rounded" rice: ```nix +{delib, ...}: delib.rice { name = "black"; inherits = ["rounded"]; @@ -19,6 +20,7 @@ delib.rice { ``` ```nix +{delib, ...}: delib.rice { name = "light"; inherits = ["rounded"]; @@ -27,6 +29,7 @@ delib.rice { ``` ```nix +{delib, ...}: delib.rice { name = "rounded"; inheritanceOnly = true; @@ -40,6 +43,7 @@ For rices to work, your configuration must include the options `${myconfigName}. Example of a minimal recommended configuration for rices: ```nix +{delib, ...}: delib.module { name = "rices"; diff --git a/docs/src/ru/hosts/examples.md b/docs/src/ru/hosts/examples.md index 741c5ee..4c5fee3 100644 --- a/docs/src/ru/hosts/examples.md +++ b/docs/src/ru/hosts/examples.md @@ -4,6 +4,7 @@ Пример минимальной конфигурации модуля хостов, который является базовой точкой для всех дальнейших настроек: ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -26,6 +27,7 @@ delib.module { Опция `type` **очень** полезна для задания значений по умолчанию в своих модулях. Например, опция `enable = boolOption host.isDesktop` может использоваться для какой-нибудь GUI программы. Это упрощает управление конфигурациями в зависимости от типа устройства. ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -55,6 +57,7 @@ delib.module { Эта опция может быть полезна для настройки мониторов, однако её можно реализовать как отдельный модуль. ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -96,6 +99,7 @@ delib.module { Использование `delib.hostNamesAssertions` настоятельно рекомендуется, но можно обойтись и без него: ```nix +{delib, ...}: delib.module { name = "hosts"; diff --git a/docs/src/ru/hosts/introduction.md b/docs/src/ru/hosts/introduction.md index 814347d..452e767 100644 --- a/docs/src/ru/hosts/introduction.md +++ b/docs/src/ru/hosts/introduction.md @@ -11,6 +11,7 @@ Пример минимальной рекомендуемой конфигурации хостов: ```nix +{delib, ...}: delib.module { name = "hosts"; diff --git a/docs/src/ru/modules/examples.md b/docs/src/ru/modules/examples.md index d1ab44f..99b9a58 100644 --- a/docs/src/ru/modules/examples.md +++ b/docs/src/ru/modules/examples.md @@ -2,6 +2,7 @@ ## Константы {#constants} ```nix +{delib, ...}: delib.module { name = "constants"; @@ -16,6 +17,7 @@ delib.module { ## Хосты {#hosts} Без опции `type`: ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -35,6 +37,7 @@ delib.module { ``` С опцией `type`: ```nix +{delib, ...}: delib.module { name = "hosts"; @@ -62,6 +65,7 @@ delib.module { ## Райсы {#rices} ```nix +{delib, ...}: delib.module { name = "rices"; @@ -83,6 +87,7 @@ delib.module { ## Home Manager {#home-manager} С [константами](#constants): ```nix +{delib, ...}: delib.module { name = "home"; @@ -100,6 +105,7 @@ delib.module { ## Пользователь {#user} С [константами](#constants): ```nix +{delib, ...}: delib.module { name = "user"; @@ -120,6 +126,7 @@ delib.module { ## Git {#git} С [константами](#constants): ```nix +{delib, ...}: delib.module { name = "programs.git"; @@ -140,6 +147,7 @@ delib.module { ## Alejandra {#alejandra} ```nix +{delib, ...}: delib.module { name = "programs.alejandra"; diff --git a/docs/src/ru/modules/introduction-nixos.md b/docs/src/ru/modules/introduction-nixos.md index 042dfdb..04420aa 100644 --- a/docs/src/ru/modules/introduction-nixos.md +++ b/docs/src/ru/modules/introduction-nixos.md @@ -85,7 +85,8 @@ optionName = lib.mkOption { Пример модуля с опциями в Denix: ```nix -{denix, ...}: delib.module { +{delib, ...}: +delib.module { name = "coolmodule"; options.coolmodule = with delib; { diff --git a/docs/src/ru/modules/introduction.md b/docs/src/ru/modules/introduction.md index 93d35d8..dd15673 100644 --- a/docs/src/ru/modules/introduction.md +++ b/docs/src/ru/modules/introduction.md @@ -6,17 +6,18 @@ ### Denix модуль ```nix -{delib, ...}: delib.module { +{delib, ...}: +delib.module { name = "..."; } ``` ### Denix модуль, дополненный NixOS/Home Manager модулем ```nix -{delib, ...}: delib.module { +{delib, ...}: +delib.module { name = "..."; -} -// { +} // { } ``` diff --git a/docs/src/ru/rices/examples.md b/docs/src/ru/rices/examples.md index dffb622..f194d5d 100644 --- a/docs/src/ru/rices/examples.md +++ b/docs/src/ru/rices/examples.md @@ -4,6 +4,7 @@ Пример минимальной конфигурации модуля райсов, который является базовой точкой для всех дальнейших настроек: ```nix +{delib, ...}: delib.module { name = "rices"; @@ -26,6 +27,7 @@ delib.module { Использование `delib.riceNamesAssertions` настоятельно рекомендуется, но можно обойтись и без него: ```nix +{delib, ...}: delib.module { name = "rices"; diff --git a/docs/src/ru/rices/introduction.md b/docs/src/ru/rices/introduction.md index 8a3ae59..be7f2d7 100644 --- a/docs/src/ru/rices/introduction.md +++ b/docs/src/ru/rices/introduction.md @@ -11,6 +11,7 @@ Пример трех райсов, где первые два наследуют все конфигурации райса "rounded": ```nix +{delib, ...}: delib.rice { name = "black"; inherits = ["rounded"]; @@ -19,6 +20,7 @@ delib.rice { ``` ```nix +{delib, ...}: delib.rice { name = "light"; inherits = ["rounded"]; @@ -27,6 +29,7 @@ delib.rice { ``` ```nix +{delib, ...}: delib.rice { name = "rounded"; inheritanceOnly = true; @@ -40,6 +43,7 @@ delib.rice { Пример минимальной рекомендуемой конфигурации для райсов: ```nix +{delib, ...}: delib.module { name = "rices";