docs: service tags

hywax · Mar 15, 2024 · 4520240 · 4520240
1 parent 2051cee
commit 4520240
Show file tree

Hide file tree

Showing 13 changed files with 217 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@
 * 🌎 **Multi-language**. Supports multiple languages.
 * 🎨 **Themes**. Customize the look to your liking.
 * 🗂️ **Grouping**. Create custom service groups.
+* 🏷️ **Tags**. Add tags to your services.
 * 👌 **Easy setup**. A few lines of yaml and your homepage is ready to go.
 * 🚀 **Fast**. Everything is fast and free of hang-ups.
 * 🐳 **Docker**. Optimized docker images for popular platforms.

diff --git a/docs/.vitepress/locales/en.ts b/docs/.vitepress/locales/en.ts
@@ -34,6 +34,7 @@ export default defineConfig({
         items: [
           { text: 'Configuration', link: '/configuration' },
           { text: 'Icons', link: '/icons' },
+          { text: 'Tags', link: '/tags' },
           { text: 'Favicons', link: '/favicons' },
         ],
       },

diff --git a/docs/.vitepress/locales/ru.ts b/docs/.vitepress/locales/ru.ts
@@ -34,6 +34,7 @@ export default defineConfig({
         items: [
           { text: 'Конфигурация', link: '/configuration' },
           { text: 'Иконки', link: '/icons' },
+          { text: 'Теги', link: '/tags' },
           { text: 'Логотип', link: '/favicons' },
         ],
       },

diff --git a/docs/index.md b/docs/index.md
@@ -32,6 +32,9 @@ features:
   - title: Grouping
     icon: 🗂
     details: Create custom service groups.
+  - title: Tags
+    icon: 🏷️
+    details: Add tags to your services.
   - title: Easy setup
     icon: 👌
     details: A few lines of yaml and your homepage is ready to go.

diff --git a/docs/public/reference/tags-dark.png b/docs/public/reference/tags-dark.png
diff --git a/docs/public/reference/tags.png b/docs/public/reference/tags.png
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
@@ -82,6 +82,22 @@ Default: `_blank`
 If a field is defined in the service `target` it will be prioritized. More details can be found in the [basic service](../services/base.md#target).
 :::
 
+## Tags <in-version value="0.10.0" />
+
+Tags allow you to differentiate between services.
+
+```yaml
+tags:
+  - name: Home
+    color: green
+  - name: Work
+    color: blue
+```
+
+::: info
+More details can be found in the [tags](../reference/tags.md) section.
+:::
+
 ## Services
 
 All services that are displayed on the home page are set in this parameter.

diff --git a/docs/reference/tags.md b/docs/reference/tags.md
@@ -0,0 +1,67 @@
+# Tags <in-version value="0.10.0" />
+
+<preview-image name="reference/tags" />
+
+Tags allow you to differentiate between services. It is quite convenient when you have several services that belong to the same project.
+
+## Name
+
+The name of the tag.
+
+```yaml
+name: Home
+```
+
+To work correctly, the tag name must be unique.
+
+## Color
+
+Color of the tag.
+
+```yaml
+color: green
+```
+
+Values: `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`
+
+Default: `blue`
+
+## Examples
+
+Two variants of using tags are presented. These examples can be used together.
+
+### Global tags
+
+If you have common tags, it's convenient to declare them at the beginning of the file and use them everywhere.
+
+```yaml
+tags:
+  - name: Home
+    color: green
+
+services:
+  - title: Home Assistant
+    description: Home automation
+    link: https://home-assistant.home.local/
+    tags:
+      - Home
+  - title: Grafana
+    description: Metrics dashboard
+    link: https://grafana.home.local/
+    tags:
+      - Home
+```
+
+### Local tags
+
+If you don't have common tags, it is convenient to use local tags. They are declared inside the service and are available only for it.
+
+```yaml
+services:
+  - title: Home Assistant
+    description: Home automation
+    link: https://home-assistant.home.local/
+    tags:
+      - name: Home
+        color: green
+```
diff --git a/docs/ru/index.md b/docs/ru/index.md
@@ -32,6 +32,9 @@ features:
   - title: Группировка
     icon: 🗂
     details: Создавайте группы сервисов
+  - title: Теги
+    icon: 🏷️
+    details: Добавьте теги к вашим сервисам.
   - title: Простая настройка
     icon: 👌
     details: Несколько строк yaml - и ваша домашняя страница готова к работе.

diff --git a/docs/ru/reference/configuration.md b/docs/ru/reference/configuration.md
@@ -82,6 +82,22 @@ behaviour:
 Если в сервисе определено поле `target`, то оно будет являться приоритетным. Подробнее можно прочитать в [базовом сервисе](../services/base.md#target)
 :::
 
+## Теги <in-version value="0.10.0" />
+
+Теги позволяют разграничивать сервисы.
+
+```yaml
+tags:
+  - name: Домашние
+    color: green
+  - name: Рабочее
+    color: blue
+```
+
+::: info Информация
+Более подробно о тегах можно прочитать в [разделе](../reference/tags.md).
+:::
+
 ## Сервисы
 
 Все сервисы, которые отображаются на главной странице задаются в данном параметре.

diff --git a/docs/ru/reference/tags.md b/docs/ru/reference/tags.md
@@ -0,0 +1,67 @@
+# Теги <in-version value="0.10.0" />
+
+<preview-image name="reference/tags" />
+
+Теги позволяют разграничивать сервисы. Довольно удобно, когда у вас есть несколько сервисов, которые относятся к одному и тому же проекту.
+
+## Название
+
+Название тега.
+
+```yaml
+name: Дом
+```
+
+Для корректной работы, название тега должно быть уникальным.
+
+## Цвет
+
+Цвет тега.
+
+```yaml
+color: green
+```
+
+Поддерживаемые значения: `red`, `orange`, `amber`, `yellow`, `lime`, `green`, `emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`, `fuchsia`, `pink`, `rose`
+
+Значение по умолчанию: `blue`
+
+## Примеры
+
+Представлено два варианта использования тегов. Данные примеры можно использовать вместе.
+
+### Глобальные теги
+
+Если у вас есть общие теги, то удобно объявить их в начале файла и использовать везде.
+
+```yaml
+tags:
+  - name: Дом
+    color: green
+
+services:
+  - title: Home Assistant
+    description: Автоматизация дома
+    link: https://home-assistant.home.local/
+    tags:
+      - Дом
+  - title: Grafana
+    description: Визуализация данных
+    link: https://grafana.home.local/
+    tags:
+      - Дом
+```
+
+### Локальные теги
+
+Если у вас нет общих тегов, то удобно использовать локальные теги. Они объявляются внутри сервиса и доступны только для него.
+
+```yaml
+services:
+  - title: Home Assistant
+    description: Автоматизация дома
+    link: https://home-assistant.home.local/
+    tags:
+      - name: Дом
+        color: green
+```
diff --git a/docs/ru/services/base.md b/docs/ru/services/base.md
@@ -79,6 +79,27 @@ icon:
 Подробнее описано в разделе [иконки](../reference/icons.md).
 :::
 
+## Теги <in-version value="0.10.0" />
+
+Теги позволяют разграничивать сервисы. Довольно удобно, когда у вас есть несколько сервисов, которые относятся к одному и тому же проекту.
+
+```yaml
+tags:
+  - name: Дом
+    color: green
+```
+
+или из глобальных тегов:
+
+```yaml
+tags:
+  - Дом
+```
+
+::: warning Настройка
+Подробнее описано в разделе [теги](../reference/tags.md).
+:::
+
 ## Статус
 
 Mafl умеет отслеживать работоспособность сервисов по ссылке, которую вы указали.

diff --git a/docs/services/base.md b/docs/services/base.md
@@ -79,6 +79,27 @@ icon:
 See [icons](../reference/icons.md) for details.
 :::
 
+## Tags <in-version value="0.10.0" />
+
+Tags allow you to differentiate between services. It is quite convenient when you have several services that belong to the same project.
+
+```yaml
+tags:
+  - name: Home
+    color: green
+```
+
+or just a list of tags:
+
+```yaml
+tags:
+  - Home
+```
+
+::: warning Settings
+See [tags](../reference/tags.md) for details.
+:::
+
 ## Status
 
 Mafl knows how to check the health of the services in the link you provided.