coder-agent/mkdocs.yml at main · Cha-Imaa/coder-agent · 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
# Docs site: `uv run mkdocs serve` locally, built with --strict and published to GitHub Pages by
# .github/workflows/docs.yml on every push to main that touches docs/ or this file.
site_name: coder-agent
site_description: A terminal coding agent built on LangGraph, MCP and local RAG, on a zero-cost stack.
site_url: https://cha-imaa.github.io/coder-agent/
repo_url: https://github.com/Cha-Imaa/coder-agent
repo_name: Cha-Imaa/coder-agent
edit_uri: edit/main/docs/
copyright: MIT licence

docs_dir: docs

# Private working notes are not part of the published site, so they are excluded here as well
# as ignored by git: a local checkout that has them still builds the same public pages.
exclude_docs: |
  PLAN.md
  TEACH.md

nav:
  - Home: index.md
  - Try it: try-it.md
  - Results: results.md
  - System design: system_design_coding_agent.md

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

# The web player on the landing page: its script and the window chrome it paints into, both
# served from docs/assets/ rather than a CDN, so the site has no third-party dependency.
extra_css:
  - assets/cast-player.css

extra_javascript:
  - assets/cast-player.js

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