PyAegis/mkdocs.yml at main · mnbplus/PyAegis · 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
site_name: PyAegis Documentation
site_description: Advanced Python Static Application Security Testing (SAST) Engine
site_author: PyAegis Team

repo_name: mnbplus/PyAegis
repo_url: https://github.com/mnbplus/PyAegis

theme:
  name: material
  palette:
    scheme: slate
    primary: deep purple
    accent: purple
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Rules:
      - Writing rules: rules.md
  - Detectors: detectors.md
  - Output Formats:
      - SARIF: sarif.md
  - Performance: performance.md
  - CI/CD integration: ci-integration.md
  - Comparison: comparison.md
  - FAQ: faq.md

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - tables