Skip to content

Commit

Permalink
docs/src/getting_started: add anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
yunfachi committed Oct 3, 2024
1 parent 8cf97d2 commit 5b54ab3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
20 changes: 10 additions & 10 deletions docs/src/getting_started/initialization.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuration Initialization
# Configuration Initialization {#initialization}
This section will describe creating the `minimal` template from scratch.

You do not have to do this; you can simply clone the minimal configuration template with the following command:
Expand All @@ -11,7 +11,7 @@ You can also copy the minimal configuration template without the rices:
nix flake init -t github:yunfachi/denix#minimal-no-rices
```

## Flake
## Flake {#flake}
First, create a directory for your configuration and a `flake.nix` file with the following content:
```nix
{
Expand Down Expand Up @@ -59,7 +59,7 @@ Code explanation:
- `denix.lib.configurations` - [Configurations (flakes) - Introduction](/configurations/introduction).
- `paths = [./hosts ./modules ./rices];` - paths to be recursively imported by Denix. Remove `./rices` if you don't want to use rices.

## Hosts
## Hosts {#hosts}
Create a `hosts` directory, and within it, create a subdirectory with the name of your host, for example, `desktop`.

In this subdirectory, create a `default.nix` file with the following content:
Expand Down Expand Up @@ -91,7 +91,7 @@ delib.host {

The `default.nix` file will be modified later after adding modules and rices, so you can keep it open.

## Rices
## Rices {#rices}
Skip this section if you do not wish to use rices.

Create a `rices` directory, and within it, create a subdirectory with the name of your rice, for example, `dark`.
Expand All @@ -104,7 +104,7 @@ delib.rice {
}
```

## Modules
## Modules {#modules}
Create a `modules` directory, and within it, create a `config` subdirectory (typically, it contains modules that are not tied to a specific program or service).

It should be mentioned that modules represent your configuration, meaning it's up to your imagination, and you are free to change the modules as you wish.
Expand All @@ -126,7 +126,7 @@ delib.module {

This file is optional, as are any of its options, which are only used by you, but it is strongly recommended as good practice.

### Hosts
### Hosts {#modules-hosts}
Also, create a `hosts.nix` file in this same directory (`modules/config`), and write any example from [Hosts - Examples](/hosts/examples).

For example, we will take ["With the `type` Option"](/hosts/examples#type-option):
Expand Down Expand Up @@ -171,7 +171,7 @@ delib.host {
}
```

### Rices
### Rices {#modules-rices}
Skip this section if you are not using rices.

In the `modules/config` directory, create a `rices.nix` file, and write any example from [Rices - Examples](/rices/examples).
Expand Down Expand Up @@ -208,7 +208,7 @@ delib.host {
}
```

### Home Manager
### Home Manager {#modules-home-manager}
If you created a [constants module](#modules-constants), just create a `home.nix` file with the following content:
```nix
{delib, ...}:
Expand Down Expand Up @@ -239,7 +239,7 @@ delib.module {
}
```

### User
### User {#modules-user}
You can also create a `user.nix` file with the configuration of your NixOS user:
```nix
{delib, ...}:
Expand Down Expand Up @@ -280,7 +280,7 @@ delib.module {
}
```

## Conclusion
## Conclusion {#conclusion}
If you have followed the instructions precisely, you will end up with the following configuration directory tree:
```plaintext
hosts
Expand Down
20 changes: 10 additions & 10 deletions docs/src/ru/getting_started/initialization.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Инициализация конфигурации
# Инициализация конфигурации {#initialization}
В этом разделе будет описано создание шаблона `minimal` с нуля.

Делать это необязательно, можно просто склонировать шаблон минимальной конфигурации с помощью команды:
Expand All @@ -11,7 +11,7 @@ nix flake init -t github:yunfachi/denix#minimal
nix flake init -t github:yunfachi/denix#minimal-no-rices
```

## Флейк
## Флейк {#flake}
Первым делом создайте директорию под вашу конфигурацию и файл `flake.nix` со следующим содержанием:
```nix
{
Expand Down Expand Up @@ -59,7 +59,7 @@ nix flake init -t github:yunfachi/denix#minimal-no-rices
- `denix.lib.configurations` - [Конфигурации (флейки) - Вступление](/ru/configurations/introduction).
- `paths = [./hosts ./modules ./rices];` - пути, которые будут рекурсивно импортированы Denix. Удалите `./rices`, если не хотите использовать райсы.

## Хосты
## Хосты {#hosts}
Создайте директорию `hosts`, а в ней поддиректорию с названием вашего хоста, например, `desktop`.

В этой поддиректории создайте файл `default.nix` со следующим содержанием:
Expand Down Expand Up @@ -91,7 +91,7 @@ delib.host {

Файл `default.nix` ещё будет изменяться после добавления модулей и райсов, поэтому его можно не закрывать.

## Райсы
## Райсы {#rices}
Пропустите этот пункт, если не хотите использовать райсы.

Создайте директорию `rices`, а в ней поддиректорию с названием вашего райса, например, `dark`.
Expand All @@ -104,7 +104,7 @@ delib.rice {
}
```

## Модули
## Модули {#modules}
Создайте директорию `modules`, а в ней поддиректорию `config` (обычно в ней находятся модули, которые не привязаны к какой-то программе или сервису).

Стоит упомянуть, что модули - это ваша конфигурация, а значит ваша фантазия, поэтому вы вольны менять модули так, как вам угодно.
Expand All @@ -126,7 +126,7 @@ delib.module {

Этот файл необязателен, так же как и любая из его опций, которые используются лишь вами, но он настоятельно рекомендуется как хорошая практика.

### Хосты
### Хосты {#modules-hosts}
Также создайте файл `hosts.nix` в этой же директории (`modules/config`), а в него запишите любой пример из [Хосты - Примеры](/ru/hosts/examples).

Для примера мы возьмём ["С опцией `type`"](/ru/hosts/examples#type-option):
Expand Down Expand Up @@ -171,7 +171,7 @@ delib.host {
}
```

### Райсы
### Райсы {#modules-rices}
Пропустите этой пункт, если вы не используете райсы.

В директории `modules/config` создайте файл `rices.nix`, а в него запишите любой пример из [Райсы - Примеры](/ru/rices/examples).
Expand Down Expand Up @@ -208,7 +208,7 @@ delib.host {
}
```

### Home Manager
### Home Manager {#modules-home-manager}
Если вы создали [модуль констант](#modules-constants), то просто создайте файл `home.nix` с таким содержанием:
```nix
{delib, ...}:
Expand Down Expand Up @@ -239,7 +239,7 @@ delib.module {
}
```

### Пользователь
### Пользователь {#modules-user}
Также можно создать файл `user.nix` с конфигурацией вашего пользователя NixOS:
```nix
{delib, ...}:
Expand Down Expand Up @@ -280,7 +280,7 @@ delib.module {
}
```

## Заключение
## Заключение {#conclusion}
Если вы чётко следовали инструкции, то в итоге у вас будет следующее дерево директории конфигурации:
```plaintext
hosts
Expand Down

0 comments on commit 5b54ab3

Please sign in to comment.