Skip to content

Commit 5b7357e

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

3 files changed

Lines changed: 14 additions & 4 deletions

File tree

.github/workflows/ci.yaml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ jobs:
2626
restore-keys: |
2727
mkdocs-material-
2828
- run: pip install -r requirements.txt
29-
- name: Patch site_url for GitHub Pages
30-
run: sed -i 's|https://mkdocs.python-cqrs.dev/|https://vadikko2.github.io/python-cqrs-mkdocs/|g' mkdocs.yml
31-
- run: mkdocs gh-deploy --force
29+
- name: Build and verify assets
30+
run: |
31+
mkdocs build --strict
32+
ls -la site/
33+
test -f site/stylesheets/extra.css || (echo "ERROR: extra.css not in build" && exit 1)
34+
test -f site/javascripts/star-link.js || (echo "ERROR: star-link.js not in build" && exit 1)
35+
- name: Deploy to GitHub Pages
36+
run: mkdocs gh-deploy --force

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,6 @@ pre-commit install
1515
```bash
1616
mkdocs serve
1717
```
18+
19+
## Deployment
20+
Стили и скрипты подключаются корректно только если в `mkdocs.yml` указан **тот же** `site_url`, что и фактический URL сайта после деплоя. Для GitHub Pages (project site) это `https://<user>.github.io/<repo>/` с завершающим слешем. Если деплой идёт на другой домен или подпуть — измените `site_url` под него, иначе тема будет отдавать неверные пути к CSS/JS и страницы откроются без оформления и анимаций.

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
site_name: python-cqrs
2-
site_url: https://mkdocs.python-cqrs.dev/
2+
# Для локальной разработки; при деплое в GitHub Pages CI подставляет правильный site_url
3+
site_url: https://vadikko2.github.io/python-cqrs-mkdocs/
34
site_description: Документация по библиотеке python-cqrs. Паттерны CQRS, Saga, Mediator и Event Driven на Python.
45
site_author: Vadim Kozyrevskii
56
repo_url: https://github.com/vadikko2/python-cqrs
@@ -126,6 +127,7 @@ plugins:
126127
- autorefs
127128
use_directory_urls: true
128129
strict: true
130+
docs_dir: docs
129131
extra_css:
130132
- stylesheets/extra.css
131133
extra_javascript:

0 commit comments

Comments
 (0)