Skip to content

Commit

Permalink
docs: base service page ru
Browse files Browse the repository at this point in the history
  • Loading branch information
hywax committed Jan 3, 2024
1 parent ee2f31f commit 1c77879
Show file tree
Hide file tree
Showing 2 changed files with 120 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/.vitepress/locales/ru.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ export default defineConfig({
],
},
{
text: 'Services',
text: 'Сервисы',
base: '/ru/services',
items: [
{ text: 'Base', link: '/base' },
{ text: 'Базовый', link: '/base' },
],
},
{
Expand Down
119 changes: 118 additions & 1 deletion docs/ru/services/base.md
Original file line number Diff line number Diff line change
@@ -1 +1,118 @@
# Base
# Базовый сервис

Основная карточка сервиса.
На основе этого сервиса создаются другие.

## Название

Заголовок сервиса

```yaml
title: Home Assistant
```
## Описание
Дополнительное описание, которое отображается сразу под заголовком.
Это поле удобно, когда у вас два одинаковых сервиса, но их нужно как-то различать.
```yaml
description: Автоматизация дома
```
## Ссылка
Ссылка на сервис. Используется при нажатии на иконку и заголовок.
Также с помощью нее происходить проверка [статуса](#статус) доступности.
```yaml
link: https://home-assistant.home.local/
```
## Иконка
Иконка сервиса. Позволяет очень быстро найти необходимы элемент.
Данное поле можно очень гибко настраивать комбинируя разные параметры.
###
```yaml
icon:
name: simple-icons:homeassistant
bubble: true
```
или из локальный файлов:
```yaml
icon:
url: icons/homeassistant.svg
background: '#eee'
```
::: warning Настройка
Подробнее описано в разделе [иконки](../reference/icons.md).
:::
## Статус
Mafl умеет отслеживать работоспособность сервисов по ссылке, которую вы указали.
```yaml
status:
enabled: true
interval: 60 # можно не указывать
```
### `enabled`

Статус включения

Поддерживаемые значения: `true`, `false`

Значение по умолчанию: `false`

### `interval`

Интервал обновления статуса.

Поддерживаемые значения: `число`

Значение по умолчанию: `60` секунд

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

## Примеры

### Базовый сервис

::: code-group
```yaml [config.yml]
services:
- title: Home Assistant
description: Автоматизация дома
link: https://home-assistant.home.local/
icon:
name: simple-icons:homeassistant
bubble: true
color: '#3dbcf3'
```
:::

### Отслеживание статуса

::: code-group
```yaml [config.yml]
services:
- title: Home Assistant
description: Автоматизация дома
link: https://home-assistant.home.local/
icon:
name: simple-icons:homeassistant
bubble: true
color: '#3dbcf3'
status:
enabled: true
```
:::

0 comments on commit 1c77879

Please sign in to comment.