Skip to content

Commit 1c77879

Browse files
committed
docs: base service page ru
1 parent ee2f31f commit 1c77879

File tree

2 files changed

+120
-3
lines changed

2 files changed

+120
-3
lines changed

Diff for: docs/.vitepress/locales/ru.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ export default defineConfig({
3636
],
3737
},
3838
{
39-
text: 'Services',
39+
text: 'Сервисы',
4040
base: '/ru/services',
4141
items: [
42-
{ text: 'Base', link: '/base' },
42+
{ text: 'Базовый', link: '/base' },
4343
],
4444
},
4545
{

Diff for: docs/ru/services/base.md

+118-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,118 @@
1-
# Base
1+
# Базовый сервис
2+
3+
Основная карточка сервиса.
4+
На основе этого сервиса создаются другие.
5+
6+
## Название
7+
8+
Заголовок сервиса
9+
10+
```yaml
11+
title: Home Assistant
12+
```
13+
14+
## Описание
15+
16+
Дополнительное описание, которое отображается сразу под заголовком.
17+
Это поле удобно, когда у вас два одинаковых сервиса, но их нужно как-то различать.
18+
19+
```yaml
20+
description: Автоматизация дома
21+
```
22+
23+
## Ссылка
24+
25+
Ссылка на сервис. Используется при нажатии на иконку и заголовок.
26+
Также с помощью нее происходить проверка [статуса](#статус) доступности.
27+
28+
```yaml
29+
link: https://home-assistant.home.local/
30+
```
31+
32+
## Иконка
33+
34+
Иконка сервиса. Позволяет очень быстро найти необходимы элемент.
35+
Данное поле можно очень гибко настраивать комбинируя разные параметры.
36+
37+
###
38+
```yaml
39+
icon:
40+
name: simple-icons:homeassistant
41+
bubble: true
42+
```
43+
44+
или из локальный файлов:
45+
46+
```yaml
47+
icon:
48+
url: icons/homeassistant.svg
49+
background: '#eee'
50+
```
51+
52+
::: warning Настройка
53+
Подробнее описано в разделе [иконки](../reference/icons.md).
54+
:::
55+
56+
## Статус
57+
58+
Mafl умеет отслеживать работоспособность сервисов по ссылке, которую вы указали.
59+
60+
```yaml
61+
status:
62+
enabled: true
63+
interval: 60 # можно не указывать
64+
```
65+
66+
### `enabled`
67+
68+
Статус включения
69+
70+
Поддерживаемые значения: `true`, `false`
71+
72+
Значение по умолчанию: `false`
73+
74+
### `interval`
75+
76+
Интервал обновления статуса.
77+
78+
Поддерживаемые значения: `число`
79+
80+
Значение по умолчанию: `60` секунд
81+
82+
::: warning Внимание
83+
Не рекомендуем менять интервал. Это может спровоцировать большую нагрузку на систему, если у вас очень много разных сервисов.
84+
:::
85+
86+
## Примеры
87+
88+
### Базовый сервис
89+
90+
::: code-group
91+
```yaml [config.yml]
92+
services:
93+
- title: Home Assistant
94+
description: Автоматизация дома
95+
link: https://home-assistant.home.local/
96+
icon:
97+
name: simple-icons:homeassistant
98+
bubble: true
99+
color: '#3dbcf3'
100+
```
101+
:::
102+
103+
### Отслеживание статуса
104+
105+
::: code-group
106+
```yaml [config.yml]
107+
services:
108+
- title: Home Assistant
109+
description: Автоматизация дома
110+
link: https://home-assistant.home.local/
111+
icon:
112+
name: simple-icons:homeassistant
113+
bubble: true
114+
color: '#3dbcf3'
115+
status:
116+
enabled: true
117+
```
118+
:::

0 commit comments

Comments
 (0)