tinygent/mkdocs.yml at master · filchy/tinygent · 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
site_name: tinygent docs
site_description: Tiny platform for amazing agents - A lightweight agentic framework for building generative AI applications
site_author: Tinygent Team
site_url: https://filchy.github.io/tinygent

# Repository
repo_name: filchy/tinygent
repo_url: https://github.com/filchy/tinygent
edit_uri: edit/master/docs/

# Navigation
nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Core Concepts:
      - Agents: concepts/agents.md
      - Tools: concepts/tools.md
      - LLMs: concepts/llms.md
      - Memory: concepts/memory.md
      - Middleware: concepts/middleware.md
  - Guides:
      - Building Agents: guides/building-agents.md
      - Custom Tools: guides/custom-tools.md
  - Examples: examples.md
  - API Reference: api-reference.md

# Theme
theme:
  name: material
  logo: assets/logo-light.svg
  favicon: assets/logo-light.svg

  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - navigation.indexes
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

  palette:
    # Light mode
    - scheme: default
      primary: black
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Dark mode
    - scheme: slate
      primary: black
      accent: lime
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

  font:
    text: Inter
    code: JetBrains Mono

# Plugins
plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'
  - tags

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/filchy/tinygent
      name: Tinygent on GitHub

  version:
    provider: mike

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Copyright
copyright: Copyright &copy; 2025 Tinygent Contributors