foca-plugins/mkdocs.yml at dev · elixir-cloud-aai/foca-plugins · 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
site_name: FOCA plugins
site_description: >-
  Plugins for gateway services built with FOCA, by ELIXIR On-Cloud
# Read the Docs serves each version under its own path (e.g., `/en/latest/`)
site_url: !ENV [READTHEDOCS_CANONICAL_URL, "https://foca-plugins.readthedocs.io/en/latest/"]
repo_url: https://github.com/elixir-cloud-aai/foca-plugins
repo_name: elixir-cloud-aai/foca-plugins
edit_uri: edit/dev/docs/
copyright: Copyright &copy; ELIXIR On-Cloud

# Python hooks of the build (not part of the site, nor their bytecode)
exclude_docs: |
  hooks.py
  __pycache__/
hooks:
  - docs/hooks.py

# Files included in pages (see `docs/hooks.py` and `pymdownx.snippets`)
watch:
  - README.md
  - plugins
  - scripts/packages.py

theme:
  name: material
  features:
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  # Sections of `README.md` (between `--8<-- [start:<name>]` and
  # `--8<-- [end:<name>]`), so that they are not written twice; fails if a
  # file or section is missing
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

plugins:
  - search

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

nav:
  - Home: index.md
  - Installing: installing.md
  - Writing a plugin: writing-plugins.md
  - Plugin catalogue: catalogue.md
  - Contributing: contributing/index.md
  - Releasing: releasing.md