linux_edr/mkdocs.yml at master · ParttimeWorks/linux_edr · 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
site_name: Linux EDR
site_description: Endpoint Detection and Response for Linux systems
site_url: https://github.com/ParttimeWorks/linux_edr

repo_name: linux-edr
repo_url: https://github.com/ParttimeWorks/linux_edr

theme:
  name: material
  palette:
    primary: indigo
    accent: blue
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - toc.integrate
    - content.code.copy
    - search.highlight
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Usage: usage.md
    - Configuration: configuration.md
  - Architecture:
    - Overview: architecture/overview.md
    - Clean Architecture: architecture/clean-architecture.md
    - Hierarchical Reporting: architecture/reporting.md
    - AI Analysis: architecture/ai-analysis.md
  - API Reference:
    - Domain:
      - Models: api/domain/models.md
    - Application:
      - Services: api/application/services.md
      - Use Cases: api/application/use_cases.md
    - Infrastructure:
      - Repositories: api/infrastructure/repositories.md
      - Trace Reader: api/trace.md
      - Aggregator: api/aggregator.md
    - Interfaces:
      - Controllers: api/interfaces/controllers.md
    - Legacy APIs:
      - Report Manager: api/report_manager.md
      - Models: api/models.md
      - Reporter: api/reporter.md
  - Development: development.md
  - Reporting: reporting.md
  - Privacy: privacy.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      toc_depth: 3

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_signature_annotations: true
            show_if_no_docstring: true
  - git-revision-date-localized:
      enable_creation_date: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ParttimeWorks/linux_edr
  version:
    provider: mike