codomyrmex/mkdocs.yml at main · docxology/codomyrmex · 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
site_name: Codomyrmex
site_url: https://docxology.github.io/codomyrmex/
repo_url: https://github.com/docxology/codomyrmex
repo_name: docxology/codomyrmex
site_description: A Modular, Extensible Coding Workspace — Documentation

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_category_heading: true
            docstring_style: google
            merge_init_into_class: true
            show_if_no_docstring: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - tables

nav:
  - Home: index.md
  - Getting Started:
      - Overview: getting-started/README.md
      - Tutorials:
          - Overview: getting-started/tutorials/README.md
          - Creating a Module: getting-started/tutorials/creating-a-module.md
          - Connecting PAI: getting-started/tutorials/connecting-pai.md
          - Using MCP Tools: getting-started/tutorials/using-mcp-tools.md
          - Running Tests: getting-started/tutorials/running-tests.md
      - Agent Operations: getting-started/GETTING_STARTED_WITH_AGENTS.md
  - Architecture:
      - Overview: architecture/README.md
  - API Reference:
      - Overview: api/README.md
  - Contributing: CONTRIBUTING.md
  - Changelog: CHANGELOG.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/docxology/codomyrmex
  version:
    provider: mike