deidentifier/mkdocs.yml at main · KatherLab/deidentifier · 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
site_name: Medical Document Anonymizer
site_description: >-
  Locally deployable anonymizer for German clinical documents. User guide,
  operator handbook, and developer reference.
site_url: https://katherlab.github.io/deidentifier/
repo_url: https://github.com/KatherLab/deidentifier
repo_name: KatherLab/deidentifier
edit_uri: edit/main/docs/
copyright: >-
  Licensed under AGPL-3.0-or-later. An internal evaluation tool — not a
  certified medical device, and not a guarantee of legal anonymization.

docs_dir: docs

theme:
  name: material
  language: en
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - search
  - include-markdown

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Getting started:
      - Overview: getting-started/index.md
      - Installation: getting-started/installation.md
      - Quickstart walkthrough: getting-started/quickstart.md
      - Core concepts: getting-started/concepts.md
  - User guide:
      - Overview: user-guide/index.md
      - Anonymizing documents: user-guide/anonymizing.md
      - Reviewing the result: user-guide/review.md
      - Advanced settings: user-guide/advanced-settings.md
      - Warnings & validation: user-guide/validation.md
      - Exporting: user-guide/export.md
  - Operations:
      - Requirements & sizing: operations/requirements.md
      - Deployment: operations/deployment.md
      - Configuration: operations/configuration.md
      - Single sign-on (OIDC): operations/sso.md
      - LLM endpoints: operations/llm-endpoints.md
      - OCR engines: operations/ocr-engines.md
      - Troubleshooting: operations/troubleshooting.md
  - Evaluation:
      - Overview: evaluation/index.md
      - Annotation formats: evaluation/data-formats.md
      - Metrics: evaluation/metrics.md
  - Security & governance:
      - Security overview: SECURITY.md
      - Threat model: THREAT_MODEL.md
      - Data flow: DATA_FLOW.md
      - Data retention: DATA_RETENTION.md
      - Risk register: RISK_REGISTER.md
      - DPIA template: DPIA_TEMPLATE.md
  - Development:
      - Contributing: development/contributing.md
      - Developer guide: development/developer-guide.md
      - Architecture: development/architecture.md
      - Testing: development/testing.md