arc-validate/mkdocs.yml at dev · nfdi4plants/arc-validate · 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
site_name: arc-validate
site_url: https://nfdi4plants.github.io/arc-validate/
site_description: Polyglot ARC validation package authoring with ARCExpect and the arc-validate CLI.
repo_url: https://github.com/nfdi4plants/arc-validate
repo_name: nfdi4plants/arc-validate

exclude_docs: |
  fsdocs/

validation:
  links:
    absolute_links: ignore

theme:
  name: material
  custom_dir: overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.instant

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true

extra:
  version: !ENV [ARC_VALIDATE_DOCS_VERSION, "dev"]

nav:
  - Home: index.md
  - ARCExpect:
      - Simple validation package: ARCExpect/simple-validation-package.md
      - Add a result payload: ARCExpect/payload.md
      - Command-line arguments: ARCExpect/command-line-arguments.md
      - API design: ARCExpect/design.md
  - arc-validate CLI:
      - Introduction: arc-validate/introduction.md
      - Validation configuration: arc-validate/validation-configuration.md
  - Development:
      - Releasing ARCExpect: development/releases.md
  - API reference: reference.md