todo-platform/docs/mkdocs.yml at main · scottseotech/todo-platform · 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
site_name: Reference Platform
site_description: Reference implementation demonstrating production-grade infrastructure patterns - GitOps, self-hosted CI/CD, full-stack observability, and ChatOps
site_author: Reference Platform
site_url: https://docs.scottseo.tech

repo_name: scottseotech/todo-platform
repo_url: https://github.com/scottseotech/todo-platform
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.instant
    - navigation.tracking
    - 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
      line_spans: __span
      pygments_lang_class: 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
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables

plugins:
  - search
  - tags

nav:
  - Home: index.md
  - Architecture:
      - Overview: architecture/overview.md
      - C4 Diagrams: architecture/c4.md
      - ADRs: architecture/adr.md
  - Development:
      - Getting Started: development/getting-started.md
  - Deployment:
      - Gitops: deployment/kubernetes.md
      - Chatops: deployment/slack-driven-release.md
  - Observability:
      - Overview: observability/observability.md
      - Log Monitoring & Alerting: observability/log-monitoring-and-alerting.md
  - ChatOps: chatops/chatops.md
  - API Reference:
      - Todo API: api/todo-api.md
      - Todo MCP: api/todo-mcp.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/scottseotech/todo-platform

  meta:
    - name: robots
      content: noindex, nofollow