netsentinel/mkdocs.yml at main · ossianericson/netsentinel · 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
site_name: NetSentinel
site_description: Network Security Scanner — Rogue Device Detector, STP Monitor & ISP Accountability Tool
site_url: https://ossianericson.github.io/netsentinel
repo_url: https://github.com/ossianericson/netsentinel
repo_name: ossianericson/netsentinel
edit_uri: edit/main/docs/

# Engineering-internal notes live under docs/ for editing convenience but must never
# reach the public site. MkDocs builds every file in docs_dir regardless of `nav`,
# so exclusion has to be explicit.
exclude_docs: |
  internal/
  spikes/
  benchmark-comparison.md

theme:
  name: material
  palette:
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link

nav:
  - Home: index.md
  - Guide:
      - Feature Reference: feature-reference.md
      - Networking Concepts: networking-guide.md
      - Validated Incident Patterns: incident-patterns.md
      - Jargon Dictionary: jargon-dictionary.md
  - Extend:
      - Hardware Integrations: hardware-plugins.md
      - Writing Scan Plugins: plugin-authoring.md
  - Develop:
      - Architecture: architecture.md
      - Chaos / Monkey Testing: chaos-testing.md
      - Contributing: contributing.md
  - Privacy Policy: privacy-policy.md

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

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ossianericson/netsentinel