Compare commits

...
2 Commits
12 changed files with 67 additions and 1403 deletions
+1 -1
View File
@@ -235,7 +235,7 @@ context:
| Material Design | `material` | <https://pictogrammers.com/library/mdi/> | - |
| FontAwesome | `fontawesome` | <https://fontawesome.com/search> | - |
| Octicons | `octicons` | <https://primer.style/octicons/> | - |
| Simple Icons | `material` | <https://simpleicons.org/> | - |
| Simple Icons | `simple` | <https://simpleicons.org/> | - |
| VSCode Codicons | `vscode` | <https://github.com/microsoft/vscode-codicons> | `./overrides/.icons/vscode` |
Полный список названий иконок здесь: <https://squidfunk.github.io/mkdocs-material/assets/javascripts/iconsearch_index.json>
+9 -9
View File
@@ -11,10 +11,9 @@ live: clear
@docker stop iptv-docs-dev 2>/dev/null; \
docker run \
--rm \
--interactive \
--tty \
--pull always \
--env PYTHONPATH=/docs \
--publish 8801:8801 \
--publish 8801:8000 \
--volume ${PWD}:/docs \
--name iptv-docs-dev \
zensical/zensical:latest
@@ -24,18 +23,19 @@ site: clear
@echo "*** Wait until zensical finish"
@docker stop iptv-docs-dev 2>/dev/null; \
docker run \
--pull always \
--rm \
--pull always \
--env PYTHONPATH=/docs \
--volume ${PWD}:/docs \
--name iptv-docs-dev \
zensical/zensical:latest \
build \
--clean
--clean \
--strict
## image = Build a docker image
image:
@docker build --tag git.axenov.dev/iptv/iptv-docs:latest:latest .
@docker build --tag git.axenov.dev/iptv/iptv-docs:latest .
## run = Run docker container from image built with `make image` on http://localhost:8802
run:
@@ -45,12 +45,12 @@ run:
--rm \
--publish 8802:80 \
--name iptv-docs \
git.axenov.dev/iptv/iptv-docs:latest:latest
git.axenov.dev/iptv/iptv-docs:latest
# push = Push docker image built with `make image` to git.axenov.dev
## push = Push docker image built with `make image` to git.axenov.dev
push:
@docker login git.axenov.dev; \
docker push git.axenov.dev/iptv/iptv-docs:latest:latest
docker push git.axenov.dev/iptv/iptv-docs:latest
## help = Show this message and exit (default)
help: Makefile
Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

+34 -3
View File
@@ -54,6 +54,13 @@ site:
- title: Исходники
url: https://git.axenov.dev/IPTV
icon: code-slash-outline
tabs:
raw:
visible: true
legal:
visible: true
text: |
<p>Юридический текст с <a href="/terms">условиями использования</a>.</p>
check:
start-on-serve: false
@@ -254,6 +261,30 @@ cache:
---
### `site.tabs.raw.visible` { id=site-tabs-raw-visible }
<!-- md:default true -->
Отображать вкладку «Исходный плейлист».
---
### `site.tabs.legal.visible` { id=site-tabs-legal-visible }
<!-- md:default true -->
Отображать вкладку «Юридическая информация».
---
### `site.tabs.legal.text` { id=site-tabs-legal-text }
HTML-контент вкладки «Юридическая информация».
Предназначена для вывода информации о правообладателях и контактах для связи с администратором сайта для решения правовых вопросов.
---
### Тип `Link` { id=link }
Элемент навигации или подвала.
@@ -266,7 +297,7 @@ cache:
| `icon` | string | Имя иконки |
| `children` | Link[] | Дочерние ссылки (выпадающее меню, один уровень вложенности) |
--8<-- "ionicons-name.md"
--8<-- "icons.md"
```yaml title="Пример"
site:
@@ -283,9 +314,9 @@ site:
icon: code-slash-outline
- title: "@iptv_aggregator"
url: https://t.me/iptv_aggregator
icon: paper-plane-outline
icon: bullhorn-variant-outline
- title: Telegram
icon: paper-plane-outline
icon: bullhorn-variant-outline
children:
- title: Канал
url: https://t.me/iptv_aggregator
+1 -1
View File
@@ -18,7 +18,7 @@ make linux
## Доступные рецепты Makefile
| Команда | Назначение |
| --- | --- |
| -------------- | ------------------------------------------------------------- |
| `make linux` | Сборка под Linux (amd64 по умолчанию) |
| `make win` | Сборка под Windows |
| `make darwin` | Сборка под macOS |
+3 -4
View File
@@ -62,10 +62,9 @@ icon: material/book-cog-outline
* make
* [docker](https://docker.com)
* [mkdocs](https://www.mkdocs.org/)
* [squidfunk/mkdocs-material](https://hub.docker.com/r/squidfunk/mkdocs-material)
* <https://squidfunk.github.io/mkdocs-material>
* <https://squidfunk.github.io/mkdocs-material/reference/admonitions/>
* [zensical](https://zensical.org/docs/get-started/)
* [zensical/zensical](https://hub.docker.com/r/zensical/zensical)
* <https://zensical.org/docs/get-started/>
* <https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/>
## Запуск mkdocs в контейнере
File diff suppressed because it is too large Load Diff
+1 -1
View File
@@ -70,7 +70,7 @@ cp /path/to/channels.json ./channels.json
Файл `compose.yml` запускает три сервиса:
| Сервис | Образ | Назначение |
| --- | --- | --- |
| ------- | -------------------------------------- | ------------------------------------------- |
| `iptvc` | `git.axenov.dev/iptv/iptvc:latest` | Веб-интерфейс и фоновая проверка плейлистов |
| `keydb` | `eqalpha/keydb:latest` | Кеш результатов проверки |
| `docs` | `git.axenov.dev/iptv/iptv-docs:latest` | Сайт документации |
+3 -3
View File
@@ -121,7 +121,7 @@ site:
url: /docs
icon: document-text-outline
- title: Telegram
icon: paper-plane-outline
icon: bullhorn-variant-outline
children:
- title: Канал
url: https://t.me/my_channel
@@ -139,7 +139,7 @@ site:
icon: person-outline
```
--8<-- "ionicons-name.md"
--8<-- "icons.md"
!!! note "base-url"
Параметр `base-url` используется для формирования внутренних ссылок.
@@ -312,7 +312,7 @@ site:
url: /docs
icon: document-text-outline
- title: Telegram
icon: paper-plane-outline
icon: bullhorn-variant-outline
children:
- title: Канал
url: https://t.me/my_channel
@@ -1,7 +1,7 @@
!!! question "Где взять имя иконки?"
Откройте галерею иконок на сайте [Ionicons](https://ionic.io/ionicons).
Кликнув на нужную иконку, внизу вы увидите её имя.
Откройте галерею иконок на сайте [Pictogrammers](https://pictogrammers.com/library/mdi/).
Кликнув на нужную иконку, вы увидите её имя.
Именно это имя используется в конфигурации iptvc.
??? image "Скриншот"
![](/_assets/img/ionicons-name.jpg)
![](/_assets/img/mdi-icon-name.jpg)
+2 -5
View File
@@ -14,7 +14,7 @@ edit_uri = "src/branch/master/content/"
docs_dir = "./content"
site_dir = "./site"
use_directory_urls = false
dev_addr = "localhost:8801"
dev_addr = "localhost:8000"
watch = ["content", "snippets"]
extra_css = ["_assets/css/extra.css"]
# extra_javascript = ["_assets/js/extra.js"]
@@ -62,11 +62,8 @@ nav = [
"common/config/config.md",
]},
# {"Для документации" = [
# {"Иконки" = [
# "iptvc/dev/docs/codicons.md",
# "iptvc/dev/docs/ionicons.md",
# ]},
# "iptvc/dev/docs/components.md",
# "iptvc/dev/docs/codicons.md",
# ]},
{"Форматы файлов" = [
"common/formats/playlists.md",