koog-docs/mkdocs.yml at main · JetBrains/koog-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
site_name: Koog
nav:
  - Documentation:
      - Overview: index.md
      - Key concepts: key-concepts.md
      - Getting started:
          - Single-run agents: single-run-agents.md
          - Complex workflow agents: complex-workflow-agents.md
      - Prompt API: prompt-api.md
      - Tools:
          - Overview: tools-overview.md
          - Built-in tools: built-in-tools.md
          - Annotation-based tools: annotation-based-tools.md
          - Class-based tools: class-based-tools.md
      - Agent events: agent-events.md
      - Agent strategies:
        - Custom strategy graphs: custom-strategy-graphs.md
        - Pre-defined nodes and components: nodes-and-components.md
        - Parallel node execution: parallel-node-execution.md
      - History compression: history-compression.md
      - Model Context Protocol: model-context-protocol.md
      - Model capabilities: model-capabilities.md
      - Content moderation: content-moderation.md
      - Advanced usage:
          - Structured data: structured-data.md
          - Streaming API: streaming-api.md
          - Custom nodes: custom-nodes.md
          - LLM sessions and manual history management: sessions.md
          - Subgraphs:
              - Overview: subgraphs-overview.md
              - Custom subgraphs: custom-subgraphs.md
          - Embeddings: embeddings.md
          - Ranked document storage: ranked-document-storage.md
          - Features:
              - Overview: features-overview.md
              - Tracing: tracing.md
              - Memory: agent-memory.md
              - Agent Persistency: agent-persistency.md
              - OpenTelemetry: opentelemetry-support.md
      - Testing: testing.md
  - Examples: examples.md
  - API reference: https://api.koog.ai/

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition

plugins:
  - search
  - redirects:
      redirect_maps:
        'simple-api-getting-started.md': 'index.md'
        'advanced-tool-implementation.md': 'class-based-tools.md'

theme:
  name: material
  custom_dir: overrides
  favicon: img/favicon.ico
  logo: img/favicon.ico
  features:
    - content.code.copy
    - navigation.expand
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
  color_mode: light
  nav_style: light
  user_color_mode_toggle: true
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
      primary: black
      accent: blue
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
      primary: black
      accent: blue

extra_css:
  - stylesheets/extra.css

repo_url: https://github.com/JetBrains/koog
repo_name: "Koog on GitHub"
copyright: Copyright © 2000-2025 JetBrains s.r.o.

extra:
  social:
    - icon: fontawesome/brands/slack
      link: https://kotlinlang.slack.com/messages/koog-agentic-framework/
      name: Koog on Slack