mkdocs.yml - main - githubmirror/sgr-agent-core

mkdocs.yml
118 строк4 KB
Pavel Rykov
docs(skills): framework docs (en+ru), nav, config example + linter pass
14 июл 2026, 14:18
14 июл 2026, 14:189060007
site_name: SGR Agent Core
site_url: https://vamplabai.github.io/sgr-agent-core/
#site_url: http://localhost:8000/
site_description: Open-source agentic framework for building intelligent research agents using Schema-Guided Reasoning. Multiple agent types, extensible architecture, OpenAI-compatible API.
repo_url: https://github.com/vamplabai/sgr-agent-core
repo_name: vamplabAI/sgr-agent-core

# OpenGraph image configuration
og_image: https://vamplabai.github.io/sgr-agent-core/assets/images/intro.jpg
og_image_alt: SGR Agent Core - Schema-Guided Reasoning Framework

plugins:
  - search
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: ru
          name: Русский
          build: true
          nav_translations:
            Get Started: Начало работы
            Welcome to SGR Agent: Добро пожаловать в SGR Agent
            Installation: Установка
            Main Concepts: Основные концепции
            User Guide: Руководство пользователя
            Using as Library: Использование как библиотека
            API Server Quick Start: Быстрый старт API сервера
            Configuration: Конфигурация
            Langfuse: Langfuse
            Build your agent: Собери своего агента
            Skills: Навыки
            Workflow: Рабочий процесс
            Demonstration: Демонстрация
            Integration & Examples: Интеграция и примеры
            Description API: Описание API
            Summary Table: Сводная таблица
            SGR vs Function Calling: SGR vs Function Calling
            Highlights: Хайлайты

theme:
  name: material
  custom_dir: docs/overrides
  icon:
    annotation: material/plus-circle
  palette:

    - scheme: slate
      primary: purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Переключить на светлую тему

    - scheme: default
      primary: purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Переключить на тёмную тему
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.code.highlight
  extra:
    social:
      - icon: fontawesome/brands/github
        link: https://github.com/vamplabai/sgr-agent-core
      - icon: fontawesome/brands/telegram
        link: https://t.me/sgragentcore
nav:
  - Get Started:
      - Welcome to SGR Agent: getting-started/index.md
      - Installation: getting-started/installation.md
  - Agent Framework:
    - Main Concepts: framework/main-concepts.md
    - User Guide:
        - Using as Library: framework/first-steps.md
        - Configuration: framework/configuration.md
        - Langfuse: framework/langfuse.md
        - Build your agent: framework/agents.md
        - Tools: framework/tools.md
        - Skills: framework/skills.md
    - QnA: framework/qna.md
  - SGR API Service:
    - API Server Quick Start: sgr-api/SGR-Quick-Start.md
    - Workflow: sgr-api/SGR-Agent's-Workflow.md
    - Demonstration: sgr-api/SGR-Demonstration.md
    - Integration & Examples: sgr-api/SGR-Integration-&-Examples.md
    - Description API: sgr-api/SGR-Description-API.md
    - Summary Table: sgr-api/SGR-Summary-table.md
    - SGR vs Function Calling: sgr-api/SGR-vs-Function-Calling_-When-to-Use-Each-Approach.md
  - Highlights: highlights.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format