mkdocs.yml - master - Al/TESamples

mkdocs.yml
128 строк5 KB
Александр Седых
fixed problem
13 май 2026, 14:24
13 май 2026, 14:24333ac5f
# =============================================================
# MkDocs config — TokenExchange documentation site.
#
# Запуск (live-reload):
#   make docs
#   # или: docker compose -f docker-compose.docs.yml up
#
# Build статики:
#   make docs-build
# =============================================================

site_name: TokenExchange — AI agent on-behalf-of
site_description: >-
  RFC 8693 Token Exchange демо в Keycloak 26.3.5 для AI-агентов,
  действующих от лица пользователя.
site_url: http://localhost:8000

docs_dir: docs

theme:
  name: material
  language: ru
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.top
    - navigation.indexes
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - toc.follow
    - announce.dismiss
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Тёмная тема
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Светлая тема
  icon:
    repo: fontawesome/brands/git-alt

markdown_extensions:
  - admonition          # !!! note / warning блоки
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - def_list
  - pymdownx.details    # collapsible-блоки (??? note)
  - pymdownx.snippets:
      # Включения через `--8<--` (если когда-то потребуется подтянуть фрагмент
      # из корневого файла — например, .env.example для quickstart).
      base_path:
        - "."
        - "docs"
      check_paths: true
  - pymdownx.superfences:
      # Custom fence для Mermaid: ```mermaid ... ``` → <div class="mermaid">.
      # Без этого Mermaid-диаграммы в .md просто отрендерятся как код.
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true   # === "tab"-style (видно в running-apps.md)
  - pymdownx.tasklist:
      custom_checkbox: true   # [ ] / [x] — стилизованные галочки
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.tilde
  - pymdownx.caret
  - pymdownx.mark
  # Шорткоды вида :material-rocket-launch: / :fontawesome-brands-github:
  # рендерятся в inline-SVG. Без этого расширения они печатаются как обычный
  # текст. Индекс и генератор берутся из самой темы Material.
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      toc_depth: 3
      # Unicode-aware slugify: anchors сохраняют русские слова
      # (`#5-анти-паттерны`, а не `#5-`). Без этого default-slugify
      # markdown'а стрипает кириллицу из id'шников.
      slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}

plugins:
  - search:
      lang:
        - ru
        - en

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/
  generator: false

# strict=false: не валим build на broken-links. Это сейчас важно для ссылок
# вида `../apps/.../EchoController.java` в running-apps.md — mkdocs не может
# их разрешить (они вне docs/), но в IDE/git-блобе они работают.
strict: false

# Навигация — порядок страниц в боковой панели. Файлы, которых нет здесь, но
# есть в docs/, всё равно билдятся, просто не появляются в навигации.
nav:
  - Главная: index.md
  - Рекомендации для клиента: client-recommendations.md
  - Гайд - реализация без фреймворков: guide-not-framework.md
  - Запуск тестовых приложений: running-apps.md
  - Глоссарий: glossary.md