aboutsummaryrefslogtreecommitdiff
path: root/docs/mkdocs.yml
blob: 3244558279feed35bfc4a051d1dcb47bf5474d16 (plain)
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
135
136
137
138
139
140
141
site_name: AutoGPT Documentation
site_url: https://docs.agpt.co/
repo_url: https://github.com/Significant-Gravitas/AutoGPT
docs_dir: content
nav:
  - Home: index.md

  - AutoGPT Agent:
      - Introduction: AutoGPT/index.md
      - Setup:
          - Setting up AutoGPT: AutoGPT/setup/index.md
          - Set up with Docker: AutoGPT/setup/docker.md
          - For Developers: AutoGPT/setup/for-developers.md
          - Configuration:
              - Options: AutoGPT/configuration/options.md
              - Search: AutoGPT/configuration/search.md
              - Voice: AutoGPT/configuration/voice.md
              - Image Generation: AutoGPT/configuration/imagegen.md
      - Components:
          - Introduction: AutoGPT/components/introduction.md
          - Agents: AutoGPT/components/agents.md
          - Components: AutoGPT/components/components.md
          - Protocols: AutoGPT/components/protocols.md
          - Commands: AutoGPT/components/commands.md
          - Built in Components: AutoGPT/components/built-in-components.md
          - Creating Components: AutoGPT/components/creating-components.md
          - Advanced: AutoGPT/components/advanced.md
      - Usage: AutoGPT/usage.md
      - Help us improve AutoGPT:
          - Share your debug logs with us: AutoGPT/share-your-logs.md
          - Contribution guide: contributing.md
          - Running tests: AutoGPT/testing.md
          - Code of Conduct: code-of-conduct.md

  - Benchmark:
      - Readme: https://github.com/Significant-Gravitas/AutoGPT/blob/master/benchmark/README.md

  - Forge:
      - Introduction: forge/get-started.md

  - Frontend:
      - Readme: https://github.com/Significant-Gravitas/AutoGPT/blob/master/frontend/README.md

  - Docs: docs/index.md

  # - Challenges:
  #     - Introduction: challenges/introduction.md
  #     - List of Challenges:
  #         - Memory:
  #             - Introduction: challenges/memory/introduction.md
  #             - Memory Challenge A: challenges/memory/challenge_a.md
  #             - Memory Challenge B: challenges/memory/challenge_b.md
  #             - Memory Challenge C: challenges/memory/challenge_c.md
  #             - Memory Challenge D: challenges/memory/challenge_d.md
  #         - Information retrieval:
  #             - Introduction: challenges/information_retrieval/introduction.md
  #             - Information Retrieval Challenge A: challenges/information_retrieval/challenge_a.md
  #             - Information Retrieval Challenge B: challenges/information_retrieval/challenge_b.md
  # - Submit a Challenge: challenges/submit.md
  # - Beat a Challenge: challenges/beat.md

  - License: https://github.com/Significant-Gravitas/AutoGPT/blob/master/LICENSE

theme:
  name: material
  custom_dir: overrides
  icon:
    logo: material/book-open-variant
  favicon: favicon.png
  features:
    - navigation.sections
    - toc.follow
    - navigation.top
    - content.code.copy
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - tables

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.critic
  - 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
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - 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

plugins:
  - table-reader
  - search

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - _javascript/tablesort.js
  - _javascript/mathjax.js
  - https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js