chatops/mkdocs.yml at main · martian56/chatops · 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
site_name: ChatOps Documentation
site_description: Comprehensive documentation for the ChatOps server monitoring and management platform
site_author: ChatOps Team
site_url: https://chatops-docs.pages.dev

# Standard MkDocs structure: config in root, docs in docs/ directory
docs_dir: docs

repo_name: martian56/chatops
repo_url: https://github.com/martian56/chatops
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - 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
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started/index.md
    - Quick Start: getting-started/quick-start.md
    - Installation: getting-started/installation.md
  - Architecture & Design:
    - Overview: architecture/index.md
    - System Architecture: architecture/system-architecture.md
    - Data Flow: architecture/data-flow.md
    - Future Architecture: architecture/future-architecture.md
  - API Reference:
    - Overview: api/index.md
    - Authentication: api/authentication.md
    - REST Endpoints: api/rest-endpoints.md
    - WebSocket API: api/websocket-api.md
    - API Keys: api/api-keys.md
  - Agent:
    - Overview: agent/index.md
    - Installation: agent/installation.md
    - Configuration: agent/configuration.md
    - Development: agent/development.md
  - Frontend:
    - Overview: frontend/index.md
    - Setup: frontend/setup.md
    - Architecture: frontend/architecture.md
  - Technologies:
    - Overview: technologies/index.md
    - Backend Stack: technologies/backend.md
    - Frontend Stack: technologies/frontend.md
    - Agent Stack: technologies/agent.md
  - Deployment:
    - Overview: deployment/index.md
    - Docker: deployment/docker.md
    - Production: deployment/production.md
  - Contributing:
    - Overview: contributing/index.md
    - Development Setup: contributing/development.md
    - Testing: contributing/testing.md

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true

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