-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
124 lines (114 loc) · 3.63 KB
/
mkdocs.yml
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
site_name: FAIR Test
site_description: |
☑️ A library to define and publish FAIR metrics tests APIs complying with the FAIRMetrics working group specifications.
Each API can expose multiple metric tests endpoint,
each test assesses the compliance of a subject URL with a FAIR principle.
Those APIs can be used by FAIR evaluation services, such as FAIR enough and the FAIR evaluator.
site_author: Vincent Emonet
site_url: https://maastrichtu-ids.github.io/fair-test
repo_name: MaastrichtU-IDS/fair-test
repo_url: https://github.com/MaastrichtU-IDS/fair-test
edit_uri: "edit/main/docs/"
copyright: Copyright © 2022 Vincent Emonet
# docs_dir: "."
theme:
name: "material"
favicon: assets/logo.png
logo: assets/logo.png
# icon:
# logo: material/microscope
language: en
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- content.code.annotate
# - content.tabs.link
# - header.autohide
# - navigation.expand
- navigation.indexes
# - navigation.instant
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# nav:
# - About: index.md
# - Usage: usage.md
# - Code reference:
# - FairTest: FairTest.md
# - FairTestAPI: FairTestAPI.md
# - Development: development.md
# - Issues: https://github.com/MaastrichtU-IDS/fair-test/issues
# https://fontawesome.com/icons/
# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
nav:
- About:
- About: index.md
- Get started: get-started.md
- Development workflow: development-workflow.md
- Create a metric test: create-test.md
- Publish: publish.md
- Contribute: contributing.md
- Code reference:
- "<span><i class='fa-solid fa-vial-circle-check'></i> FairTestEvaluation</span>": FairTestEvaluation.md
- "<span><i class='fa-solid fa-flask'></i> FairTest</span>": FairTest.md
- "<span><i class='fa-solid fa-flask-vial'></i> FairTestAPI</span>": FairTestAPI.md
- "<span>Issues <i class='fa-solid fa-arrow-up-right-from-square'></i></span>": https://github.com/MaastrichtU-IDS/fair-test/issues" target="_blank
plugins:
# - admonition
- search
- autorefs
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: true
# custom_templates: templates
watch:
- src
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
markdown_extensions:
- admonition
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- attr_list
- smarty
extra_css:
- assets/custom.css
extra_javascript:
- assets/fontawesome.min.js
- assets/solid.min.js
extra:
social:
- icon: fontawesome/brands/python
link: https://pypi.org/project/fair-test
- icon: fontawesome/brands/github
link: https://github.com/MaastrichtU-IDS
# - icon: fontawesome/brands/docker
# link: https://github.com/orgs/MaastrichtU-IDS/packages
- icon: fontawesome/brands/twitter
link: https://twitter.com/um_ids