cloudrift/mkdocs.yml at main · inayathulla/cloudrift · 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
site_name: Cloudrift
site_description: Pre-apply Terraform Drift Detection & Compliance CLI
site_url: https://inayathulla.github.io/cloudrift/
repo_url: https://github.com/inayathulla/cloudrift
repo_name: inayathulla/cloudrift

theme:
  name: material
  custom_dir: docs/overrides
  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
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - 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
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.keys
  - 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
  - toc:
      permalink: true

plugins:
  - search
  - minify:
      minify_html: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - AWS Credentials: getting-started/aws-credentials.md
  - CLI Reference:
    - Scan Command: cli/scan-command.md
    - Output Formats: cli/output-formats.md
  - Features:
    - Drift Detection: features/drift-detection.md
    - Policy Engine: features/policy-engine.md
    - Compliance Frameworks: features/compliance.md
    - CI/CD Integration: features/ci-cd.md
  - Policy Reference:
    - Overview: policies/overview.md
    - S3: policies/s3.md
    - EC2: policies/ec2.md
    - Security Groups: policies/security-groups.md
    - RDS: policies/rds.md
    - IAM: policies/iam.md
    - CloudTrail: policies/cloudtrail.md
    - KMS: policies/kms.md
    - ELB: policies/elb.md
    - EBS: policies/ebs.md
    - Lambda: policies/lambda.md
    - CloudWatch Logs: policies/logging.md
    - VPC: policies/vpc.md
    - Secrets Manager: policies/secrets.md
    - Tagging: policies/tagging.md
    - Cost: policies/cost.md
  - Architecture:
    - Overview: architecture/overview.md
    - Data Flow: architecture/data-flow.md
    - Project Structure: architecture/project-structure.md
    - Deployment: architecture/deployment.md
  - Development:
    - Local Setup: development/local-setup.md
    - Adding Services: development/adding-services.md
    - Adding Policies: development/adding-policies.md
    - Testing: development/testing.md
  - Contributing: contributing.md