strixeyecom.github.io/mkdocs.yml at master · strixeyecom/strixeyecom.github.io · 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
site_name: StrixEye Documentation
site_url: https://docs.strixeye.com
extra_css:
  - assets/stylesheets/extra.css

theme:
  name: material
  custom_dir: overrides
  logo: assets/images/white.svg
  favicon: assets/images/purple.png
  font:
    text: Ubuntu
    code: Ubuntu mono

  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    - media: "(prefers-color-scheme: light)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.expand

# Navigation
nav:
  - Welcome: index.md
  - Installation: installation.md
  - Configure Trigger and Integration: configure_trigger_integration.md
  - In-Depth Dashboard:
      # - Dashboard: in-depth_dashboard/dashboard.md
      - Suspects: in-depth_dashboard/suspects.md
      - Suspicions: in-depth_dashboard/suspicions.md
      - Agents: in-depth_dashboard/agents.md
      - Domains: in-depth_dashboard/domains.md
      - Integrations: in-depth_dashboard/integrations.md
      - Trigger Rules: in-depth_dashboard/trigger_rules.md
      - Users: in-depth_dashboard/users.md
      - Roles: in-depth_dashboard/roles.md
      - Profile: in-depth_dashboard/profile.md
      - Company Info: in-depth_dashboard/company_info.md
  # - In-Depth Agent:
  #     - Cli: triggers/delete.md
  #     - Agent: triggers/delete.md
  # - Mirror Requests:
  #     - NGINX: triggers/delete.md
  #     - Apache: triggers/delete.md
  #     - IIS: triggers/delete.md
  #     - AWS Load Balancer: triggers/delete.md
  #     - Traefik: triggers/delete.md

# Plugins
plugins:
  - search
  - minify:
      minify_html: true

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid-experimental
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  # analytics:
  #   provider: google
  #   property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/strixeyecom
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/StrixEye
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/strixeye