pid4cat-model/mkdocs.yml at main · nfdi4cat/pid4cat-model · 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
125
126
127
128
129
130
131
132
133
134
135
136
137
---
site_name: pid4cat Documentation
site_description: >-
  Persistent identifiers for FAIR catalysis data. pid4cat combines Handle PIDs
  with structured LinkML metadata for samples, devices, and research resources.
site_url: https://nfdi4cat.github.io/pid4cat-model
repo_url: https://github.com/nfdi4cat/pid4cat-model

theme:
  # https://www.mkdocs.org/user-guide/configuration/#theme
  name: material
  # logo-customization
  # https://github.com/squidfunk/mkdocs-material/discussions/2729
  custom_dir: docs/overrides
  logo_dark_mode: images/logo-icon.svg
  logo_light_mode: images/logo-icon.svg

  # Toggling between default/light/dark color schemes
  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
  palette:
    # Palette toggle for automatic mode
    - media: (prefers-color-scheme)
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: blue grey
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: blue grey
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - content.tabs.link
    - content.code.copy  # enable copy to clipboard
    - header.autohide  # maximum screen space during scrolling
    - navigation.expand  # optimize user experience
    - navigation.instant  # optimize user experience
    - navigation.instant.progress
    - navigation.tracking  # update address bar
    - search.highlight
    - search.suggest  # suggest good completions

  favicon: images/favicon.svg

# extra css/js see
# https://www.mkdocs.org/user-guide/customizing-your-theme/
extra_css:
  - stylesheets/extra.css

# extra_javascript:
#   - js/extra-loader.js

plugins:
  - search
  - mknotebooks:
      execute: false
  - mermaid2:
      # Optionally provide a local copy of mermaid.js (path relative to docs/)
      # javascript: local-js-pkgs/mermaid.min.js
      version: 11.4.1

  # Multi-version support https://github.com/jimporter/mike
  - mike:
      canonical_version: latest
      version_selector: true

  # https://pypi.org/project/mkdocs-pymdownx-material-extras
  - mkdocs_pymdownx_material_extras:

markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      # https://mkdocs-mermaid2.readthedocs.io/en/latest/superfences
      # custom code highlighting rules
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom

# TODO rebuild docs on schema change
# https://github.com/dalito/linkml-project-copier/issues/39
# - gen-files:
#     scripts:
#       - gen_pages.py  # or any other name or path

watch:
  - src/pid4cat_model/schema

not_in_nav: |
  /elements/**/*.md

nav:
  - Home: index.md
  - Overview: overview.md
  - Getting Started: getting-started.md
  - Metadata:
      - Basics: metadata.md
      - Schema: elements/overview.md
      - Versioning: versioning.md
  - APIs: apis.md
  - Tools & Services: tools.md
  - Open Data: open-data.md
  - About:
      - Credits: about.md
      - Policies: policies.md

# enable version selector for multi-version support
extra:
  version:
    provider: mike
    alias: true
    default:
      - stable

exclude_docs: |
  /templates-linkml/

# Uncomment this block to enable use of Google Analytics.
# Replace the property value with your own ID.
# extra:
#   analytics:
#     provider: google
#     property: G-XXXXXXXXXX