coder-k8s/mkdocs.yml at main · coder/coder-k8s · 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
site_name: coder-k8s
repo_url: https://github.com/coder/coder-k8s
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - content.action.edit
    - search.suggest
    - search.highlight

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - search

extra_javascript:
  - https://unpkg.com/mermaid@11/dist/mermaid.min.js
  - javascripts/mermaid.js

nav:
  - Home: index.md
  - Tutorials:
      - Deploy a Coder Control Plane: tutorials/getting-started.md
      - Deploy an External Provisioner: tutorials/deploy-coderprovisioner.md
      - Deploy with Argo CD: tutorials/deploy-with-argocd.md
  - How-to guides:
      - Deploy the controller: how-to/deploy-controller.md
      - Deploy the aggregated API server: how-to/deploy-aggregated-apiserver.md
      - Start, stop, and read logs of workspaces: how-to/start-stop-workspaces.md
      - Test a template version: how-to/test-templates.md
      - Gate template promotion with GitOps: how-to/gitops.md
      - Run the MCP server: how-to/mcp-server.md
      - Troubleshooting: how-to/troubleshooting.md
  - Reference:
      - Aggregated API behavior: reference/aggregated-api-behavior.md
      - API:
          # BEGIN GENERATED API NAV
          - CoderControlPlane: reference/api/codercontrolplane.md
          - CoderProvisioner: reference/api/coderprovisioner.md
          - CoderTemplateTest: reference/api/codertemplatetest.md
          - CoderWorkspaceProxy: reference/api/coderworkspaceproxy.md
          - CoderTemplate: reference/api/codertemplate.md
          - CoderTemplateVersion: reference/api/codertemplateversion.md
          - CoderWorkspace: reference/api/coderworkspace.md
          # END GENERATED API NAV
  - Explanation:
      - Architecture: explanation/architecture.md