ai-bom/mkdocs.yml at main · Trusera/ai-bom · 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
site_name: AI-BOM Documentation
site_description: AI Bill of Materials — discover and inventory all AI/LLM components
site_url: https://trusera.github.io/ai-bom/
repo_url: https://github.com/trusera/ai-bom
repo_name: trusera/ai-bom

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_bases: true
            heading_level: 3

nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Quick Start: quickstart.md
    - Configuration: configuration.md
  - Scanners:
    - Overview: scanners/index.md
    - Code Scanner: scanners/code.md
    - Docker Scanner: scanners/docker.md
    - Network Scanner: scanners/network.md
    - Cloud Scanner: scanners/cloud.md
    - n8n Scanner: scanners/n8n.md
    - Jupyter Scanner: scanners/jupyter.md
    - GitHub Actions Scanner: scanners/github-actions.md
    - Model File Scanner: scanners/model-files.md
    - MCP Config Scanner: scanners/mcp-config.md
    - AST Scanner: scanners/ast.md
  - Output Formats:
    - Overview: outputs/index.md
    - Table: outputs/table.md
    - CycloneDX: outputs/cyclonedx.md
    - SARIF: outputs/sarif.md
    - SPDX 3.0: outputs/spdx3.md
    - HTML: outputs/html.md
    - CSV: outputs/csv.md
    - JUnit: outputs/junit.md
    - Markdown: outputs/markdown.md
  - LLM Enrichment: enrichment.md
  - CI/CD Integration: ci-integration.md
  - Policy Enforcement: policy.md
  - Compliance:
    - OWASP Agentic Top 10: compliance/owasp.md
    - EU AI Act: compliance/eu-ai-act.md
  - CLI Reference: cli-reference.md
  - REST API: api.md
  - Troubleshooting: troubleshooting.md
  - Changelog: changelog.md

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