feat(site): добавлен MkDocs Material сайт с CI/CD на GitHub Pages
- Зачем: - роадмап нуждается в презентабельном виде с навигацией и поиском, а не только GitHub README. - Что: - создан mkdocs.yml (Material, docs_dir: ., поиск на русском, тёмная/светлая тема). - создан .github/workflows/deploy-site.yml (push в main → сборка → GitHub Pages). - адаптирован Markdown для dual compatibility (GitHub + MkDocs): пустые строки перед списками, отступы 2sp→4sp, заголовки README #→## для корректного TOC. - заменены em-dash на запятые в 4 заголовках dwh-modeling/README.md (фикс расхождения якорей). - добавлены правила Markdown Style и команды MkDocs/Playwright в AGENTS.md. - Проверка: - uv run --with 'mkdocs-material==9.6.14' --with 'mkdocs-same-dir==0.1.3' mkdocs build --strict
This commit is contained in:
@@ -0,0 +1,43 @@
|
||||
name: Deploy MkDocs to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.x"
|
||||
|
||||
- run: pip install mkdocs-material==9.6.14 mkdocs-same-dir==0.1.3
|
||||
|
||||
- run: mkdocs build --strict
|
||||
|
||||
- uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
path: site/
|
||||
|
||||
deploy:
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
steps:
|
||||
- id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
Reference in New Issue
Block a user