Skip to content

Commit

Permalink
feat(docs/introduction): add id to headers
Browse files Browse the repository at this point in the history
  • Loading branch information
yunfachi committed Aug 18, 2024
1 parent c3790a9 commit c1c643e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Introduction
# Introduction {#introduction}
In this section, you will learn about what Denix is, why it is needed, who can benefit from it, and popular practices for system configuration.

## What is Denix
## What is Denix {#what-is-denix}
Denix is a Nix library designed for creating scalable configurations for [NixOS](https://nixos.org/) and [Home Manager](https://github.com/nix-community/home-manager).

It provides functions that transform input data into a module according to a specific algorithm. Thanks to this, if for any reason you need to create a module without using Denix, it will be sufficient to import the file with it, and everything will work.
Expand All @@ -13,14 +13,14 @@ The provided functions are generally divided into five categories:
- [Hosts](#hosts)
- [Rices](#rices)

## Why and Who Needs Denix
## Why and Who Needs Denix {#why-and-who-needs-denix}
Denix is primarily needed to simplify the creation, editing, and readability of configuration code. It eliminates the need to create typical expressions for your own modules, hosts, rices, etc.

If you plan to expand your configuration across multiple machines (hosts), want to have various system settings (rices) that can be changed with a single command, and strive to write readable and clean code, then you should consider trying Denix. Conversely, if you're creating a small configuration for a single machine and don't plan to expand it, Denix might be unnecessary.

Configuration templates using Denix can be found in the `templates` directory of the GitHub repository: [github:yunfachi/denix?path=templates](https://github.com/yunfachi/denix/tree/master/templates).

## Modules
## Modules {#modules}
Custom modules are possibly the best practice for creating scalable configurations.

A module includes options, configuration, and importing other modules.
Expand Down Expand Up @@ -72,7 +72,7 @@ delib.module {
```
You can learn more about Denix modules in [TODO](/TODO).

## Hosts
## Hosts {#hosts}
Host is any machine, such as a personal computer, server, etc.

The essence of this practice is to separate the configuration into a shared part and a unique part for each host.
Expand All @@ -96,7 +96,7 @@ delib.host {
```
You can learn more about Denix hosts in [TODO](/TODO).

## Rices
## Rices {#rices}
Rice is a slang term used to describe system settings, especially related to appearance.

In our case, this is any configuration not tied to a specific host.
Expand Down
12 changes: 6 additions & 6 deletions docs/src/ru/introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Введение
# Введение {#introduction}
В этом разделе вы узнаете о том, что такое Denix, зачем он нужен и кому может быть полезен, а также о популярных практиках конфигурирования системы.

## Что такое Denix
## Что такое Denix {#what-is-denix}
Denix - это библиотека для Nix, предназначенная для создания масштабируемых конфигураций [NixOS](https://nixos.org/) и [Home Manager](https://github.com/nix-community/home-manager).

Она предоставляет функции, которые по определённому алгоритму преобразуют входные данные в модуль. Благодаря этому, если по какой-либо причине вам необходимо создать модуль без использования Denix, будет достаточно импортировать файл с ним, и всё будет работать.
Expand All @@ -13,14 +13,14 @@ Denix - это библиотека для Nix, предназначенная
- [Хосты](#хосты)
- [Райсы](#райсы)

## Зачем и кому нужен Denix
## Зачем и кому нужен Denix {#why-and-who-needs-denix}
Denix в первую очередь нужен для упрощения создания, редактирования и улучшения читаемости кода конфигураций. Он избавляет от необходимости создавать типичные выражения для создания своих модулей, хостов, райсов и т.д.

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

Шаблоны конфигураций с использованием Denix можно найти в директории `templates` репозитория на GitHub: [github:yunfachi/denix?path=templates](https://github.com/yunfachi/denix/tree/master/templates).

## Модули
## Модули {#modules}
Собственные модули - это, возможно, лучшая практика для создания масштабируемых конфигураций.

Модуль включает в себя опции (options), конфигурацию (config) и импорт других модулей (imports).
Expand Down Expand Up @@ -72,7 +72,7 @@ delib.module {
```
Более подробно о модулях Denix можно узнать в [TODO](/TODO).

## Хосты
## Хосты {#hosts}
Хост (host) - это машина, такая как персональный компьютер, сервер и т.д.

Суть этой практики - разделение конфигурации на общую и уникальную для каждого хоста.
Expand All @@ -96,7 +96,7 @@ delib.host {
```
Более подробно о хостах Denix можно узнать в [TODO](/TODO).

## Райсы
## Райсы {#rices}
Райс (rice) - это жаргонный термин, обозначающий настройки системы, обычно связанные с внешним видом.

В нашем случае это любая конфигурация, не привязанная к какому-либо хосту.
Expand Down

0 comments on commit c1c643e

Please sign in to comment.