cloud-audit/mkdocs.yml at main · gebalamariusz/cloud-audit · 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
site_name: cloud-audit
site_description: Open-source AWS security scanner with attack chains, compliance, and copy-paste fixes
site_url: https://haitmg.pl/cloud-audit
repo_url: https://github.com/gebalamariusz/cloud-audit
repo_name: gebalamariusz/cloud-audit

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

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/gebalamariusz/cloud-audit
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/cloud-audit/

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

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Demo Mode: getting-started/demo.md
  - Features:
    - Blast Radius: features/blast-radius.md
    - Attack Chains: features/attack-chains.md
    - IAM Privilege Escalation: features/iam-escalation.md
    - Threat Feed: features/threat-feed.md
    - What-If Simulator: features/simulate.md
    - Security Posture Trend: features/trend.md
    - AI-SPM (Bedrock/SageMaker): features/ai-spm.md
    - Remediation: features/remediation.md
    - Breach Cost Estimation: features/breach-cost.md
    - Health Score: features/health-score.md
    - Scan Diff: features/scan-diff.md
    - MCP Server: features/mcp-server.md
  - Compliance:
    - Overview: compliance/overview.md
    - CIS AWS v3.0: compliance/cis-aws-v3.md
    - SOC 2 Type II: compliance/soc2-type2.md
    - BSI C5:2020: compliance/bsi-c5-2020.md
    - ISO 27001:2022: compliance/iso27001-2022.md
    - HIPAA Security Rule: compliance/hipaa-security.md
    - NIS2 Directive: compliance/nis2-directive.md
  - Checks:
    - All Checks: checks/index.md
  - Configuration:
    - Config File: configuration/config-file.md
    - Environment Variables: configuration/environment-variables.md
    - Suppressions: configuration/suppressions.md
  - CI/CD:
    - GitHub Actions: ci-cd/github-actions.md
    - SARIF Integration: ci-cd/sarif.md
    - Pre-commit Hooks: ci-cd/pre-commit.md
  - Reports:
    - HTML Report: reports/html.md
    - JSON & SARIF: reports/json-sarif.md
    - Markdown: reports/markdown.md
  - Alternatives: alternatives.md
  - Contributing: contributing.md
  - Changelog: changelog.md