IPTV/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Activity

Упаковка в docker

Browse Source
This commit is contained in:
Anthony Axenov
2025-11-22 17:18:34 +08:00
parent 0e626ac48b
commit 49b85a6bee
3 changed files with 51 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/dev/docs.md
View File

@@ -17,7 +17,7 @@ icon: material/book-cog-outline
**Каждое предложение должно быть на одной строке.**
Это даёт более наглядную разницу (diff) в тексте при работе с git.
Абзацы и списки должны отделяться 1 пустой строкой сверху и снизу.
Абзацы и списки должны отделяться 1 пустой строкой до и после.
Допустимо использовать любые стилистические возможности темы **Material for MkDocs** и самого **mkdocs**, но не следует визуально перегружать текст.
Документацию по ним см. по ссылкам ниже.
@@ -74,24 +74,30 @@ icon: material/book-cog-outline
make live
```
Перегенерирует документацию на лету сразу после изменения файлов.
Перегенерирует документацию на лету сразу после сохранения файлов.
Открывает [localhost:3000](http://localhost:3000) для просмотра изменений в реальном времени.
Документацию в реальном времени можно просматривать по адресу [localhost:3000](http://localhost:3000).
## Генерация статических файлов
## Генерация статического сайта
```
make build
```
Генерирует статические файлы, которую можно версионировать и хранить/деплоить отдельно.
Открывает [localhost:8080/docs](http://localhost:8080/docs) для просмотра сгенерированной документации.
Генерирует статические файлы, которую можно версионировать, хранить,деплоить отдельно или просматривать на ПК через браузер.
Готовый скомпилированный статический сайт с документацией находится в директории `site/`.
Он же хранится в репозитории вместе с исходными файлами, потому что:
* я посчитал это **более удобным для деплоя**: ради редких обновлений нет смысла тратить ресурсы серверов на ci/cd, actions по хукам и перманентную работу `mkdocs` в режиме `build`;
* я посчитал это **более удобным для использования**: можно в любой момент открыть актуальную документацию в браузере через `site/index.html` без необходимости `make` и `docker`.
## Генерация docker-образа
Пересборка должна происходить перед каждым коммитом.
```
make image
```
Собирает docker-образ на основе nginx, генерируя перед этим статический сайт.
Запустить контейнер из этого образа можно командой:
```
make run
```