chem-dcat-ap/mkdocs.yml at main · nfdi-de/chem-dcat-ap · 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
---
site_name: "ChemDCAT-AP Documentation"
site_url: https://nfdi-de.github.io/chem-dcat-ap
repo_url: https://github.com/nfdi-de/chem-dcat-ap

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
    - search.highlight
    - navigation.expand
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking

  favicon: 'images/favicon.svg'

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


plugins:
  - search
  - mknotebooks:
      execute: false
  - mermaid2:
      version: 11.4.1
      # Optionally provide a local copy of mermaid.js (path relative to docs/)
      # javascript: local-js-pkgs/mermaid.min.js
  - mike:
      # Multi-version support, https://github.com/jimporter/mike
      canonical_version: "latest"
      version_selector: true

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

watch:
  - src/chem_dcat_ap/schema

nav:
  - Home: index.md
  - Schema: elements/overview.md
  - Versioning: versioning.md
  - About: about.md

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

markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      # make exceptions to highlighting of code:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
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