Nemesis/mkdocs.yml at main · SpecterOps/Nemesis · 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
site_name: Nemesis Documentation
site_url: https://specterops.github.io/Nemesis/
repo_url: https://github.com/SpecterOps/Nemesis
repo_name: SpecterOps/Nemesis
edit_uri: edit/main/docs/

plugins:
  - search

exclude_docs: |
  /requirements.txt

nav:
  - Nemesis: index.md
  - Quickstart: quickstart.md

  - Usage:
    - usage_guide.md
    - enrichment_configuration.md
    - alerting.md
    - cli.md
    - agents.md
    - chatbot.md
    - troubleshooting.md
    - yara.md
    - Titus Rules: titus_rules.md
    - Chromium Analysis: chromium.md
    - DPAPI Analysis: dpapi.md
    - Container Processing: containers.md
    - reporting.md
    - Performance Tuning: performance.md

  - Services:
    - hasura.md
    - jupyter.md
    - housekeeping.md

  - Developer:
    - Project Overview: overview.md
    - Adding File Enrichment Modules: file_enrichment_modules.md
    - Operational Data Reference: odr.md
    - Docker Compose Documentation: docker_compose.md
    - Kubernetes Deployment (k3d): kubernetes.md
    - Kubernetes Deployment (EKS): eks.md
    - Nemesis API: api.md

theme:
  name: material
  locale: en
  logo: images/logo.png
  favicon: images/logo.png

  features:
    - navigation.sections
    - content.code.copy

  icon:
    repo: fontawesome/brands/github

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: nemesis-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: nemesis-dark
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - stylesheets/colors.css

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.highlight:
      use_pygments: true