Compare commits
2
Commits
890674dea0
...
9d817f65d8
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9d817f65d8
|
||
|
|
f85c61d273
|
@@ -235,7 +235,7 @@ context:
|
|||||||
| Material Design | `material` | <https://pictogrammers.com/library/mdi/> | - |
|
| Material Design | `material` | <https://pictogrammers.com/library/mdi/> | - |
|
||||||
| FontAwesome | `fontawesome` | <https://fontawesome.com/search> | - |
|
| FontAwesome | `fontawesome` | <https://fontawesome.com/search> | - |
|
||||||
| Octicons | `octicons` | <https://primer.style/octicons/> | - |
|
| 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` |
|
| VSCode Codicons | `vscode` | <https://github.com/microsoft/vscode-codicons> | `./overrides/.icons/vscode` |
|
||||||
|
|
||||||
Полный список названий иконок здесь: <https://squidfunk.github.io/mkdocs-material/assets/javascripts/iconsearch_index.json>
|
Полный список названий иконок здесь: <https://squidfunk.github.io/mkdocs-material/assets/javascripts/iconsearch_index.json>
|
||||||
|
|||||||
@@ -11,10 +11,9 @@ live: clear
|
|||||||
@docker stop iptv-docs-dev 2>/dev/null; \
|
@docker stop iptv-docs-dev 2>/dev/null; \
|
||||||
docker run \
|
docker run \
|
||||||
--rm \
|
--rm \
|
||||||
--interactive \
|
--pull always \
|
||||||
--tty \
|
|
||||||
--env PYTHONPATH=/docs \
|
--env PYTHONPATH=/docs \
|
||||||
--publish 8801:8801 \
|
--publish 8801:8000 \
|
||||||
--volume ${PWD}:/docs \
|
--volume ${PWD}:/docs \
|
||||||
--name iptv-docs-dev \
|
--name iptv-docs-dev \
|
||||||
zensical/zensical:latest
|
zensical/zensical:latest
|
||||||
@@ -24,18 +23,19 @@ site: clear
|
|||||||
@echo "*** Wait until zensical finish"
|
@echo "*** Wait until zensical finish"
|
||||||
@docker stop iptv-docs-dev 2>/dev/null; \
|
@docker stop iptv-docs-dev 2>/dev/null; \
|
||||||
docker run \
|
docker run \
|
||||||
--pull always \
|
|
||||||
--rm \
|
--rm \
|
||||||
|
--pull always \
|
||||||
--env PYTHONPATH=/docs \
|
--env PYTHONPATH=/docs \
|
||||||
--volume ${PWD}:/docs \
|
--volume ${PWD}:/docs \
|
||||||
--name iptv-docs-dev \
|
--name iptv-docs-dev \
|
||||||
zensical/zensical:latest \
|
zensical/zensical:latest \
|
||||||
build \
|
build \
|
||||||
--clean
|
--clean \
|
||||||
|
--strict
|
||||||
|
|
||||||
## image = Build a docker image
|
## image = Build a docker image
|
||||||
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 = Run docker container from image built with `make image` on http://localhost:8802
|
||||||
run:
|
run:
|
||||||
@@ -45,12 +45,12 @@ run:
|
|||||||
--rm \
|
--rm \
|
||||||
--publish 8802:80 \
|
--publish 8802:80 \
|
||||||
--name iptv-docs \
|
--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:
|
push:
|
||||||
@docker login git.axenov.dev; \
|
@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 = Show this message and exit (default)
|
||||||
help: Makefile
|
help: Makefile
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 65 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
@@ -54,6 +54,13 @@ site:
|
|||||||
- title: Исходники
|
- title: Исходники
|
||||||
url: https://git.axenov.dev/IPTV
|
url: https://git.axenov.dev/IPTV
|
||||||
icon: code-slash-outline
|
icon: code-slash-outline
|
||||||
|
tabs:
|
||||||
|
raw:
|
||||||
|
visible: true
|
||||||
|
legal:
|
||||||
|
visible: true
|
||||||
|
text: |
|
||||||
|
<p>Юридический текст с <a href="/terms">условиями использования</a>.</p>
|
||||||
|
|
||||||
check:
|
check:
|
||||||
start-on-serve: false
|
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 }
|
### Тип `Link` { id=link }
|
||||||
|
|
||||||
Элемент навигации или подвала.
|
Элемент навигации или подвала.
|
||||||
@@ -266,7 +297,7 @@ cache:
|
|||||||
| `icon` | string | Имя иконки |
|
| `icon` | string | Имя иконки |
|
||||||
| `children` | Link[] | Дочерние ссылки (выпадающее меню, один уровень вложенности) |
|
| `children` | Link[] | Дочерние ссылки (выпадающее меню, один уровень вложенности) |
|
||||||
|
|
||||||
--8<-- "ionicons-name.md"
|
--8<-- "icons.md"
|
||||||
|
|
||||||
```yaml title="Пример"
|
```yaml title="Пример"
|
||||||
site:
|
site:
|
||||||
@@ -283,9 +314,9 @@ site:
|
|||||||
icon: code-slash-outline
|
icon: code-slash-outline
|
||||||
- title: "@iptv_aggregator"
|
- title: "@iptv_aggregator"
|
||||||
url: https://t.me/iptv_aggregator
|
url: https://t.me/iptv_aggregator
|
||||||
icon: paper-plane-outline
|
icon: bullhorn-variant-outline
|
||||||
- title: Telegram
|
- title: Telegram
|
||||||
icon: paper-plane-outline
|
icon: bullhorn-variant-outline
|
||||||
children:
|
children:
|
||||||
- title: Канал
|
- title: Канал
|
||||||
url: https://t.me/iptv_aggregator
|
url: https://t.me/iptv_aggregator
|
||||||
|
|||||||
@@ -17,14 +17,14 @@ make linux
|
|||||||
|
|
||||||
## Доступные рецепты Makefile
|
## Доступные рецепты Makefile
|
||||||
|
|
||||||
| Команда | Назначение |
|
| Команда | Назначение |
|
||||||
| --- | --- |
|
| -------------- | ------------------------------------------------------------- |
|
||||||
| `make linux` | Сборка под Linux (amd64 по умолчанию) |
|
| `make linux` | Сборка под Linux (amd64 по умолчанию) |
|
||||||
| `make win` | Сборка под Windows |
|
| `make win` | Сборка под Windows |
|
||||||
| `make darwin` | Сборка под macOS |
|
| `make darwin` | Сборка под macOS |
|
||||||
| `make release` | Сборка под все платформы (linux/windows/darwin × amd64/arm64) |
|
| `make release` | Сборка под все платформы (linux/windows/darwin × amd64/arm64) |
|
||||||
| `make clean` | Удаление скомпилированных бинарников |
|
| `make clean` | Удаление скомпилированных бинарников |
|
||||||
| `make help` | Вывод списка доступных рецептов |
|
| `make help` | Вывод списка доступных рецептов |
|
||||||
|
|
||||||
## Управление архитектурой
|
## Управление архитектурой
|
||||||
|
|
||||||
|
|||||||
@@ -62,10 +62,9 @@ icon: material/book-cog-outline
|
|||||||
|
|
||||||
* make
|
* make
|
||||||
* [docker](https://docker.com)
|
* [docker](https://docker.com)
|
||||||
* [mkdocs](https://www.mkdocs.org/)
|
* [zensical](https://zensical.org/docs/get-started/)
|
||||||
* [squidfunk/mkdocs-material](https://hub.docker.com/r/squidfunk/mkdocs-material)
|
* [zensical/zensical](https://hub.docker.com/r/zensical/zensical)
|
||||||
* <https://squidfunk.github.io/mkdocs-material>
|
* <https://zensical.org/docs/get-started/>
|
||||||
* <https://squidfunk.github.io/mkdocs-material/reference/admonitions/>
|
|
||||||
* <https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/>
|
* <https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/>
|
||||||
|
|
||||||
## Запуск mkdocs в контейнере
|
## Запуск mkdocs в контейнере
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -69,11 +69,11 @@ cp /path/to/channels.json ./channels.json
|
|||||||
|
|
||||||
Файл `compose.yml` запускает три сервиса:
|
Файл `compose.yml` запускает три сервиса:
|
||||||
|
|
||||||
| Сервис | Образ | Назначение |
|
| Сервис | Образ | Назначение |
|
||||||
| --- | --- | --- |
|
| ------- | -------------------------------------- | ------------------------------------------- |
|
||||||
| `iptvc` | `git.axenov.dev/iptv/iptvc:latest` | Веб-интерфейс и фоновая проверка плейлистов |
|
| `iptvc` | `git.axenov.dev/iptv/iptvc:latest` | Веб-интерфейс и фоновая проверка плейлистов |
|
||||||
| `keydb` | `eqalpha/keydb:latest` | Кеш результатов проверки |
|
| `keydb` | `eqalpha/keydb:latest` | Кеш результатов проверки |
|
||||||
| `docs` | `git.axenov.dev/iptv/iptv-docs:latest` | Сайт документации |
|
| `docs` | `git.axenov.dev/iptv/iptv-docs:latest` | Сайт документации |
|
||||||
|
|
||||||
Сервис `iptvc` публикует порт `8800`, а `docs` — порт `8801`.
|
Сервис `iptvc` публикует порт `8800`, а `docs` — порт `8801`.
|
||||||
|
|
||||||
|
|||||||
@@ -121,7 +121,7 @@ site:
|
|||||||
url: /docs
|
url: /docs
|
||||||
icon: document-text-outline
|
icon: document-text-outline
|
||||||
- title: Telegram
|
- title: Telegram
|
||||||
icon: paper-plane-outline
|
icon: bullhorn-variant-outline
|
||||||
children:
|
children:
|
||||||
- title: Канал
|
- title: Канал
|
||||||
url: https://t.me/my_channel
|
url: https://t.me/my_channel
|
||||||
@@ -139,7 +139,7 @@ site:
|
|||||||
icon: person-outline
|
icon: person-outline
|
||||||
```
|
```
|
||||||
|
|
||||||
--8<-- "ionicons-name.md"
|
--8<-- "icons.md"
|
||||||
|
|
||||||
!!! note "base-url"
|
!!! note "base-url"
|
||||||
Параметр `base-url` используется для формирования внутренних ссылок.
|
Параметр `base-url` используется для формирования внутренних ссылок.
|
||||||
@@ -312,7 +312,7 @@ site:
|
|||||||
url: /docs
|
url: /docs
|
||||||
icon: document-text-outline
|
icon: document-text-outline
|
||||||
- title: Telegram
|
- title: Telegram
|
||||||
icon: paper-plane-outline
|
icon: bullhorn-variant-outline
|
||||||
children:
|
children:
|
||||||
- title: Канал
|
- title: Канал
|
||||||
url: https://t.me/my_channel
|
url: https://t.me/my_channel
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
!!! question "Где взять имя иконки?"
|
!!! question "Где взять имя иконки?"
|
||||||
Откройте галерею иконок на сайте [Ionicons](https://ionic.io/ionicons).
|
Откройте галерею иконок на сайте [Pictogrammers](https://pictogrammers.com/library/mdi/).
|
||||||
Кликнув на нужную иконку, внизу вы увидите её имя.
|
Кликнув на нужную иконку, вы увидите её имя.
|
||||||
Именно это имя используется в конфигурации iptvc.
|
Именно это имя используется в конфигурации iptvc.
|
||||||
|
|
||||||
??? image "Скриншот"
|
??? image "Скриншот"
|
||||||

|

|
||||||
+2
-5
@@ -14,7 +14,7 @@ edit_uri = "src/branch/master/content/"
|
|||||||
docs_dir = "./content"
|
docs_dir = "./content"
|
||||||
site_dir = "./site"
|
site_dir = "./site"
|
||||||
use_directory_urls = false
|
use_directory_urls = false
|
||||||
dev_addr = "localhost:8801"
|
dev_addr = "localhost:8000"
|
||||||
watch = ["content", "snippets"]
|
watch = ["content", "snippets"]
|
||||||
extra_css = ["_assets/css/extra.css"]
|
extra_css = ["_assets/css/extra.css"]
|
||||||
# extra_javascript = ["_assets/js/extra.js"]
|
# extra_javascript = ["_assets/js/extra.js"]
|
||||||
@@ -62,11 +62,8 @@ nav = [
|
|||||||
"common/config/config.md",
|
"common/config/config.md",
|
||||||
]},
|
]},
|
||||||
# {"Для документации" = [
|
# {"Для документации" = [
|
||||||
# {"Иконки" = [
|
|
||||||
# "iptvc/dev/docs/codicons.md",
|
|
||||||
# "iptvc/dev/docs/ionicons.md",
|
|
||||||
# ]},
|
|
||||||
# "iptvc/dev/docs/components.md",
|
# "iptvc/dev/docs/components.md",
|
||||||
|
# "iptvc/dev/docs/codicons.md",
|
||||||
# ]},
|
# ]},
|
||||||
{"Форматы файлов" = [
|
{"Форматы файлов" = [
|
||||||
"common/formats/playlists.md",
|
"common/formats/playlists.md",
|
||||||
|
|||||||
Reference in New Issue
Block a user