Skip to content

Commit 5e9c60a

Browse files
author
Вадим Козыревский
committed
Update documentation
1 parent 5b7357e commit 5e9c60a

3 files changed

Lines changed: 10 additions & 3 deletions

File tree

.github/workflows/ci.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ jobs:
2626
restore-keys: |
2727
mkdocs-material-
2828
- run: pip install -r requirements.txt
29+
- name: Patch site_url for GitHub Pages
30+
run: |
31+
sed -i 's|https://mkdocs.python-cqrs.dev/|https://vadikko2.github.io/python-cqrs-mkdocs/|g' mkdocs.yml
2932
- name: Build and verify assets
3033
run: |
3134
mkdocs build --strict

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,8 @@ mkdocs serve
1717
```
1818

1919
## Deployment
20-
Стили и скрипты подключаются корректно только если в `mkdocs.yml` указан **тот же** `site_url`, что и фактический URL сайта после деплоя. Для GitHub Pages (project site) это `https://<user>.github.io/<repo>/` с завершающим слешем. Если деплой идёт на другой домен или подпуть — измените `site_url` под него, иначе тема будет отдавать неверные пути к CSS/JS и страницы откроются без оформления и анимаций.
20+
Стили и скрипты подключаются корректно только если в `mkdocs.yml` указан **тот же** `site_url`, что и фактический URL сайта после деплоя.
21+
22+
- **Timeweb (Docker)** — в репозитории уже задан `site_url: https://mkdocs.python-cqrs.dev/`; сборка через Docker использует его как есть.
23+
- **GitHub Pages** — в CI перед сборкой подставляется `site_url` для `https://vadikko2.github.io/python-cqrs-mkdocs/`.
24+
- Другой домен/подпуть — задайте свой `site_url` в `mkdocs.yml` (с завершающим слешем) или подменяйте его при сборке.

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: python-cqrs
2-
# Для локальной разработки; при деплое в GitHub Pages CI подставляет правильный site_url
3-
site_url: https://vadikko2.github.io/python-cqrs-mkdocs/
2+
# Деплой на Timeweb: https://mkdocs.python-cqrs.dev/ ; для GitHub Pages CI подставляет свой URL
3+
site_url: https://mkdocs.python-cqrs.dev/
44
site_description: Документация по библиотеке python-cqrs. Паттерны CQRS, Saga, Mediator и Event Driven на Python.
55
site_author: Vadim Kozyrevskii
66
repo_url: https://github.com/vadikko2/python-cqrs

0 commit comments

Comments
 (0)