bdc-variable-library/mkdocs.yml at main · linkml/bdc-variable-library · 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
---
site_name: "bdc-variable-library"
theme:
  # https://www.mkdocs.org/user-guide/configuration/#theme
  name: material
  icon:
    logo: material/book-open-page-variant
  # palette:
  #  scheme: slate
  #  primary: cyan
  features:
    - content.tabs.link
    - 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.suggest       # suggest good completions
    - content.code.copy    # enable copy to clipboard

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

plugins:
  - search
  - mknotebooks:
      execute: false
  - mermaid2:
      version: 11.4.1
  # https://pypi.org/project/mkdocs-pymdownx-material-extras
  - mkdocs_pymdownx_material_extras:

markdown_extensions:
  - pymdownx.superfences:
      # https://mkdocs-mermaid2.readthedocs.io/en/latest/superfences
      # custom code highlighting rules
      custom_fences:
        - name: mermaid
          # disable code highlighting to display diagrams
          format: !!python/name:pymdownx.superfences.fence_code_format
          class: mermaid
  # https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
  # auto-link HTML, FTP, and email links
  - pymdownx.magiclink
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition
  # support for call-outs
  - admonition
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#tables
  # create tables
  - tables
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
  # enables use of HTML attributes and CSS classes to applicable elements
  - attr_list
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html
  # write markdown inside of HTML
  - md_in_html

watch:
  - src/bdc_variable_library/schema

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

exclude_docs: |
  /templates-linkml/

site_url: https://linkml.github.io/bdc-variable-library
repo_url: https://github.com/linkml/bdc-variable-library

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