terravision/mkdocs.yml at main · patrickchugh/terravision · 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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
site_name: TerraVision
site_description: Turn Terraform code into professional cloud architecture diagrams that stay in sync with your infrastructure — automatic, secure, living documents.
site_url: https://patrickchugh.github.io/terravision/
repo_url: https://github.com/patrickchugh/terravision
repo_name: patrickchugh/terravision
edit_uri: edit/main/docs/
copyright: Copyright &copy; Patrick Chugh

docs_dir: docs

theme:
  name: material
  palette:
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - search.suggest
    - search.highlight
    - search.share
  icon:
    repo: fontawesome/brands/github
  font:
    text: Inter
    code: JetBrains Mono

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - no-lightbox
      auto_caption: false
      caption_position: bottom

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Usage Guide: usage-guide.md
  - Features:
      - Annotations: annotations.md
      - CI/CD Integration: cicd-integration.md
  - Help:
      - FAQ: faq.md
      - Troubleshooting: troubleshooting.md
  - Contributing:
      - Contributing Guide: CONTRIBUTING.md
      - Developer Guide: developer-guide.md
      - Resource Handler Guide: resource-handler-guide.md
      - Project Constitution: constitution.md
  - Live Demos:
      - AWS Demo: demo-aws.html
      - Azure Demo: demo-azure.html
      - GCP Demo: demo-gcp.html

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/patrickchugh/terravision
    - icon: fontawesome/brands/youtube
      link: https://youtu.be/bTrWHBI2mF4
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/terravision/

exclude_docs: |
  CLAUDE.md
  LEARNINGS_*.md
  metadata-refactor-plan.md
  README.md