Публикация документации¶
Сайт собирается из папки docs/ с помощью MkDocs Material. Главная страница —
docs/README.md, меню и оформление настраиваются в mkdocs.yml.
Unity-проект и внешние каталоги ассетов не входят в публикацию.
Ссылки на файлы вне docs/ ведут в исходный репозиторий GitHub и требуют доступа к нему.
Локальные инструменты на 127.0.0.1 доступны только на компьютере разработчика.
Что настроено в репозитории¶
Сборка MkDocs, тема, меню и обработка ссылок уже подготовлены. Технический план
по фичам и отдельный план ассетов для художника включены в меню «Разработка».
Новые Markdown-файлы внутри docs/ попадают в сборку; для отображения отдельного
пункта меню нужно также добавить страницу в nav файла mkdocs.yml.
Локальная сборка проверена 16 октября 2026 командой mkdocs build --strict.
Это подтверждает готовность файлов сайта, но не подключение внешнего хостинга.
Создание проекта Cloudflare Pages, привязка репозитория, включённые автоматические
production deployments и успешный deploy проверяются в аккаунте Cloudflare.
Действующий сайт: idle-world-domination-docs.pages.dev.
Доступность сайта проверена 16 октября 2026: HTTP 200. Наличие работающего сайта
само по себе не подтверждает автоматическое обновление; его проверяют после push.
После подключения по инструкции ниже обычный цикл обновления:
- Изменить документацию и при необходимости меню.
- Проверить
mkdocs build --strict. - Закоммитить изменения и отправить их в
master. - Cloudflare Pages автоматически собирает и публикует новую версию.
Сохранение файла только на компьютере не публикует его. Для автоматической
публикации из Git нужен push в подключённую ветку; отдельный ручной upload
папки site/ при этом не требуется. Если проект Pages уже существует,
проверить его настройки вместо создания второго проекта.
Локальная проверка¶
В корне репозитория, с установленным Python 3.12:
python -m venv .venv-docs
Windows PowerShell:
.\.venv-docs\Scripts\python.exe -m pip install -r requirements-docs.txt
.\.venv-docs\Scripts\python.exe -m mkdocs build --strict
.\.venv-docs\Scripts\python.exe -m mkdocs serve
macOS / Linux:
.venv-docs/bin/python -m pip install -r requirements-docs.txt
.venv-docs/bin/python -m mkdocs build --strict
.venv-docs/bin/python -m mkdocs serve
Cloudflare Pages¶
В Cloudflare: Workers & Pages → Create application → Pages → Import an existing
Git repository. Подключить только GreatVV/IdleWorldDomination.
| Настройка | Значение |
|---|---|
| Project name | idle-world-domination-docs (если имя свободно) |
| Production branch | master |
| Framework preset | None |
| Root directory | Корень репозитория, поле оставить пустым |
| Build command | pip install -r requirements-docs.txt && python -m mkdocs build --strict |
| Build output directory | site |
| Environment variable | PYTHON_VERSION=3.12 |
После первого успешного развёртывания Cloudflare выдаст адрес https://<project>.pages.dev.
Дальнейшие push в master автоматически обновляют сайт. В Build watch paths
можно указать docs/*, mkdocs.yml, requirements-docs.txt, tools/docs/*,
чтобы изменения Unity-проекта не запускали сборку документации.
Репозиторий остаётся private, сайт документации публичный. Публикуется только
содержимое собранной папки site/. Не помещать в docs/ секреты и материалы,
которые не должны быть доступны посетителям сайта.
Официальные инструкции: MkDocs на Cloudflare Pages и настройки сборки.