cloudaudit/mkdocs.yml at main · xtawb/cloudaudit · 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
site_name: CloudAudit
site_description: >-
  Next-Generation AI-Powered Cloud Security Auditing Framework —
  Defensive. Intelligent. Enterprise-Grade.
site_url: https://cloudaudit.readthedocs.io
repo_url: https://github.com/xtawb/cloudaudit
repo_name: xtawb/cloudaudit
edit_uri: edit/main/docs/

copyright: >-
  CloudAudit v1.0.1 — Developed by xtawb |
  <a href="https://linktr.ee/xtawb">https://linktr.ee/xtawb</a>

theme:
  name: material
  palette:
    - scheme: slate
      primary: deep orange
      accent: orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - scheme: default
      primary: deep orange
      accent: orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.annotate
    - content.code.copy
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Configuration: configuration.md
  - Architecture:
      - Overview: architecture.md
      - AI Engine: ai-engine.md
      - Detection Algorithms: detection-algorithms.md
      - Risk Engine: risk-engine.md
      - Reporting: reporting.md
  - API Reference:
      - AI Providers: api/providers.md
      - Scanners: api/scanners.md
      - Models: api/models.md
  - Operations:
      - Update System: update-system.md
      - Contributing: contributing.md

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/xtawb/cloudaudit
    - icon: fontawesome/solid/link
      link: https://linktr.ee/xtawb