noxaudit/mkdocs.yml at main · atriumn/noxaudit · 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
site_name: Noxaudit
site_url: https://docs.noxaudit.com
site_description: AI-powered codebase audits with rotating focus areas, multi-provider support, and decision memory.
repo_url: https://github.com/atriumn/noxaudit
repo_name: atriumn/noxaudit

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - toc.follow

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Your First Audit: getting-started/first-audit.md
  - Guides:
      - Configuration: guides/configuration.md
      - Focus Areas: guides/focus-areas.md
      - Decision Memory: guides/decisions.md
      - Usage Patterns: guides/scheduling.md
      - Cost Management: guides/cost-management.md
      - Notifications: guides/notifications.md
  - Integrations:
      - GitHub Actions: integrations/github-actions.md
      - GitHub Issues: integrations/github-issues.md
      - SARIF & Code Scanning: integrations/sarif.md
      - MCP Server: integrations/mcp-server.md
  - Reference:
      - CLI: reference/cli.md
      - Configuration: reference/configuration.md
      - Providers: reference/providers.md
  - Benchmark: benchmark.md
  - Contributing: contributing/index.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - minify:
      minify_html: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/atriumn/noxaudit