openmed/mkdocs.yml at master · maziyarpanahi/openmed · 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
113
114
115
116
117
118
119
120
121
122
123
124
site_name: OpenMed
site_description: "Open-source healthcare NLP toolkit with curated models, advanced NER, and one-call orchestration."
site_url: https://openmed.life/docs/
site_dir: site/docs
repo_url: https://github.com/maziyarpanahi/openmed
repo_name: maziyarpanahi/openmed
edit_uri: edit/master/docs/
copyright: "© {year} Maziyar Panahi — Apache-2.0"
strict: true

nav:
  - Overview:
      - Welcome: index.md
      - Feature Map: feature-map.md
      - Quick Start: getting-started.md
  - Core Guides:
      - Analyze Text Helper: analyze-text.md
      - REST Service (MVP): rest-service.md
      - ModelLoader & Pipelines: model-loader.md
      - Model Registry: model-registry.md
      - Advanced NER & Output Formatting: output-formatting.md
      - Medical Tokenizer: medical-tokenizer.md
      - Configuration & Validation: configuration.md
      - Configuration Profiles: profiles.md
      - Batch Processing: batch-processing.md
      - Performance Profiling: profiling.md
      - Zero-shot Toolkit: zero-shot-ner.md
      - Examples & Copy/Paste Recipes: examples.md
      - Testing & QA: testing.md
  - PII & De-identification:
      - Smart Entity Merging: pii-smart-merging.md
  - Project:
      - Contributing & Releases: contributing.md

theme:
  name: material
  language: en
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tracking
    - toc.integrate
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - announce.dismiss

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/maziyarpanahi/openmed
      name: GitHub
    - icon: simple/huggingface
      link: https://huggingface.co/OpenMed
      name: Hugging Face
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/MaziyarPanahi
      name: Maziyar on X
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/openmed-ai/
      name: LinkedIn

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
  - minify:
      minify_html: true

hooks:
  - docs/_hooks.py

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      permalink_title: Link to this section
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

watch:
  - openmed
  - openmed/zero_shot

exclude_docs: |
  website/**