vens/mkdocs.yml at main · venslabs/vens · 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
site_name: Vens
site_description: Prioritize vulnerabilities by real risk, not just CVSS. Scores each CVE based on your system's actual context.
site_url: https://venslabs.github.io/vens/
repo_url: https://github.com/venslabs/vens
repo_name: venslabs/vens
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  logo: assets/vens-logo.svg
  favicon: assets/vens-favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

extra_css:
  - stylesheets/landing.css

extra_javascript:
  - javascripts/landing.js

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

plugins:
  - search
  - blog:
      post_url_format: "{slug}"
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true

exclude_docs: |
  TRIVY_PLUGIN.md
  testing.md
  prompt-testing.md
  requirements.txt

nav:
  - Home: index.md
  - Getting Started:
      - GitHub Actions: guides/github-actions.md
      - Installation: getting-started/installation.md
      - Quickstart (5 min): getting-started/quickstart.md
  - Guides:
      - Prioritize a CVE backlog: guides/prioritize-cves.md
      - Describe your context: guides/configuration.md
  - Concepts:
      - What is a VEX file?: concepts/what-is-vex.md
      - CVSS vs OWASP contextual: concepts/cvss-vs-owasp.md
      - Privacy and data flow: concepts/privacy-and-data-flow.md
      - Vens vs alternatives: concepts/alternatives.md
      - Choosing an LLM: concepts/choosing-a-model.md
      - Limitations: concepts/limitations.md
  - Blog: blog/index.md
  - Reference:
      - config.yaml schema: reference/config-schema.md
      - vens generate: reference/generate.md
      - vens enrich: reference/enrich.md
  - Troubleshooting: troubleshooting.md