Skip to content

Commit 340ec39

Browse files
yunfachimzonski
authored andcommitted
docs/src/ru/extensions/all-extensions: add overlays
1 parent 99c2fbe commit 340ec39

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/src/ru/extensions/all-extensions.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,3 +135,42 @@
135135

136136
## User {#user}
137137
WIP
138+
139+
## Overlays {#overlays}
140+
<table class="extension-table">
141+
<tbody>
142+
<tr>
143+
<th>Имя</th>
144+
<td><code>overlays</code></td>
145+
</tr>
146+
<tr>
147+
<th>Описание</th>
148+
<td>Модуль упрощённой конфигурация оверлеев</td>
149+
</tr>
150+
<tr>
151+
<th>Ответственные</th>
152+
<td>Zonni (<a href='https://github.com/mzonski'>GitHub</a>)</td>
153+
</tr>
154+
</tbody>
155+
</table>
156+
157+
### Настройки {#overlays-settings}
158+
| Имя | Значение по умолчанию | Описание |
159+
| - | - | - |
160+
| `defaultTargets` | `["nixos" "home"]` | Цели по умолчанию, к которым будут применяться оверлеи |
161+
| `moduleNamePrefix` | `"overlays"` | Префикс, добавляемый к именам модулей, когда `withPrefix` равняется true |
162+
163+
### Библиотека {#overlays-library}
164+
165+
#### `overlayModule` {#overlays-library-overlayModule}
166+
Создаёт модуль, который применяет оверлеи к указанным целям. Если `withPrefix` равен true, создаётся опция `${moduleNamePrefix}.${name}.enable` со значением `delib.overlayModule :: enabled`; в противном случае то же самое создаётся в `${name}.enable`.
167+
168+
**Аргументы:**
169+
| Имя | Тип | Значение по умолчанию | Описание |
170+
| - | - | - | - |
171+
| `name` | string | *обязательный* | Имя модуля этого оверлея |
172+
| `overlay` | overlay function | `null` | Применяемый оверлей |
173+
| `overlays` | list of overlay functions | `[]` | Список применяемых оверлеев |
174+
| `targets` | list of strings | [`defaultTargets`](#overlays-settings) | Целевые системы, к которым будут применены оверлеи. Разрешённые значения: `"nixos"`, `"home"`, `"darwin"` |
175+
| `withPrefix` | boolean | `true` | Добавлять ли `moduleNamePrefix` перед именем модуля этого оверлея |
176+
| `enabled` | boolean | `true` | Включать ли этот оверлей по умолчанию |

0 commit comments

Comments
 (0)