kingfisher/docs-site/mkdocs.yml at c73a44fbf9229ec175dfcfc504150d78ddba68e2 · mongodb/kingfisher · 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
site_name: Kingfisher
site_url: https://mongodb.github.io/kingfisher
site_description: >-
  Open source secret scanner with live validation. 942 detection rules,
  blast radius mapping, credential revocation, and a browser-based
  report viewer that also imports Gitleaks and TruffleHog output.
  Built in Rust by MongoDB.
site_author: MongoDB
repo_url: https://github.com/mongodb/kingfisher
repo_name: mongodb/kingfisher

copyright: Copyright &copy; 2024-2026 MongoDB, Inc.

theme:
  name: material
  custom_dir: overrides
  logo: assets/images/kingfisher_logo.png
  favicon: assets/images/kingfisher_logo.png
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - minify:
      minify_html: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.snippets
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
  - Usage:
    - Basic Scanning: usage/basic-scanning.md
    - Platform Integrations: usage/integrations.md
    - Advanced Configuration: usage/advanced.md
    - Baseline Management: usage/baseline.md
    - Deployment: usage/deployment.md
  - Features:
    - Access Map (Blast Radius): features/access-map.md
    - Hosted Report Viewer: features/report-viewer.md
    - Secret Revocation: features/revocation.md
    - Source Code Parsing: features/parsing.md
    - Finding Fingerprints: features/fingerprints.md
    - LLM & Agent Integration: features/agents.md
  - Rules:
    - Built-in Rules List: rules/builtin-rules.md
    - Writing Custom Rules: rules/overview.md
  - Reference:
    - Architecture: reference/architecture.md
    - Rust Library Crates: reference/library.md
    - Python Bindings: reference/python-bindings.md
    - Benchmarks & Comparison: reference/comparison.md
  - Report Viewer: https://mongodb.github.io/kingfisher/viewer/
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mongodb/kingfisher

extra_css:
  - assets/stylesheets/extra.css

extra_javascript:
  - assets/javascripts/rules-filter.js