-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdocs.yml
306 lines (293 loc) · 10.9 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
---
# {{{ Main site config
site_name: documentation.eccenca.com
site_url: https://documentation.eccenca.com/
repo_url: https://github.com/eccenca/documentation.eccenca.com
edit_uri: ./edit/main/docs
copyright: >
Copyright © 2024
<a target="_blank" rel="noopener" href="https://eccenca.com">eccenca GmbH</a>
extra:
analytics:
provider: google
property: G-VS3GZMYY28
# https://squidfunk.github.io/mkdocs-material/reference/?h=status#setting-the-page-status
status:
new: Recently added or extended
deprecated: Deprecated
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/?h=social#social-links
social:
# - icon: fontawesome/brands/docker
# link: https://hub.docker.com/u/eccenca
- icon: fontawesome/brands/creative-commons
link: >
https://github.com/eccenca/documentation.eccenca.com/blob/main/LICENSE
- icon: fontawesome/brands/github
link: https://github.com/eccenca
- icon: fontawesome/brands/python
link: https://pypi.org/user/eccenca/
- icon: fontawesome/brands/twitter
link: https://twitter.com/eccenca
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/eccenca-gmbh/
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
tags:
# here tags are mapped to icons
Video: video
ReleaseNote: release-note
Vocabulary: vocabulary
Configuration: configuration
Dashboards: dashboards
BestPractice: best-practice
KnowledgeGraph: knowledge-graph
Java: java
Security: security
API: api
Reference: reference
Workflow: workflow
Automate: automate
cmemc: cmemc
Docker: docker
Python: python
PythonPlugin: python-plugin
SPARQL: sparql
BeginnersTutorial: beginners
AdvancedTutorial: advanced
ExpertTutorial: expert
Project: project
Keycloak: keycloak
Validation: validation
Filesystem: material-file-tree
Volume: fontawesome-solid-hard-drive
"Load Balancer": simple-awselasticloadbalancing
Variables: variables
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
version:
provider: mike
# https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-syntax-theme
extra_css:
- assets/extra.css
extra_javascript:
# https://squidfunk.github.io/mkdocs-material/reference/data-tables/#sortable-tables
- https://unpkg.com/[email protected]/dist/tablesort.min.js
- assets/tablesort.js
- assets/extra.js
# }}}
# {{{ Theme configuration
theme:
name: material
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/
language: en
# https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme
custom_dir: overrides
# used from assets/extra.css
palette:
- scheme: eccenca-light
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/
font:
text: Roboto
code: Roboto Mono
favicon: assets/favicon.svg
logo: assets/favicon.svg
features:
# add button to dismiss the current announcement
- announce.dismiss
# on search highlight all occurrences after following the link
- search.highlight
# allows to deep link to the current search query and result
- search.share
# search will display the likeliest completion for the last word
- search.suggest
# sidebar is scrolled so that the active anchor is always visible
- toc.follow
# allow numeric annotion markers in block and inline comments
- content.code.annotate
# same label tabs are linked and switch to the same label
- content.tabs.link
# replaces the browser tooltips
- content.tooltips
# documents can be directly attached to sections, which is particularly
# useful for providing overview pages.
- navigation.indexes
# clicks on all internal links will be intercepted and dispatched via XHR
# without fully reloading the page
- navigation.instant
# top-level sections are rendered in a menu layer below the header
- navigation.tabs
# top level sections will lock below the header and always remain visible
- navigation.tabs.sticky
# add back-to-top button
- navigation.top
# URL in the address bar is automatically updated with the active anchor as
# highlighted in the table of contents.
- navigation.tracking
# left sidebar will expand all collapsible subsections by default
# - navigation.expand
# significantly smaller HTML files for documentation projects with huge
# navigation hierarchies.
# - navigation.prune
# top-level sections are rendered as groups in the sidebar for viewports
# above 1220px
# - navigation.sections
# - header.autohide
# - toc.integrate
# 404 page
static_templates:
- 404.html
# Necessary for search to work properly
include_search_page: false
search_index_only: true
icon:
logo: logo
tag:
# https://squidfunk.github.io/mkdocs-material/reference/?h=page+icon#setting-the-page-icon
video: material/video-outline
release-note: material/calendar
vocabulary: material/graph-outline
configuration: material/tune
dashboards: material/view-dashboard
best-practice: material/thumb-up-outline
knowledge-graph: eccenca/artefact-dataset-eccencadataplatform
java: material/language-java
security: material/server-security
api: material/api
reference: octicons/cross-reference-24
workflow: eccenca/artefact-workflow
automate: other/powerautomate
cmemc: octicons/terminal-16
docker: fontawesome/brands/docker
python: fontawesome/brands/python
python-plugin: fontawesome/brands/python
sparql: material/database-eye-outline
beginners: material/list-status
advanced: material/list-status
expert: material/list-status
project: eccenca/artefact-project
keycloak: material/openid
validation: octicons/verified-16
material-file-tree: material/file-tree
simple-awselasticloadbalancing: simple/awselasticloadbalancing
fontawesome-solid-hard-drive: fontawesome/solid/hard-drive
variables: material/variable-box
# https://squidfunk.github.io/mkdocs-material/reference/annotations/
admonition:
note: fontawesome/solid/note-sticky
abstract: fontawesome/solid/book
info: fontawesome/solid/circle-info
tip: fontawesome/solid/bullhorn
success: fontawesome/solid/check
question: fontawesome/solid/circle-question
warning: fontawesome/solid/triangle-exclamation
failure: fontawesome/solid/bomb
danger: fontawesome/solid/skull
bug: fontawesome/solid/robot
example: fontawesome/solid/flask
quote: fontawesome/solid/quote-left
# }}}
# {{{ Extensions to the markdown processor
markdown_extensions:
# multi extension: https://python-markdown.github.io/extensions/extra/
- extra
# converts ASCII dashes, quotes and ellipses to their HTML entity equivalents
- smarty
# ordered list will not continue when an unordered item comes and vice versa
- sane_lists
# add HTML attributes and CSS classes to Markdown inline and block elements
- attr_list
# writing Markdown inside of HTML
- md_in_html
# https://squidfunk.github.io/mkdocs-material/reference/annotations/
- admonition
# collapsible admonitions
- pymdownx.details
# support for syntax highlighting of code blocks
- pymdownx.highlight:
anchor_linenums: true
# support for syntax highlighting of inline code blocks
- pymdownx.inlinehilite
# adds the ability to embed content from arbitrary files into a document
- pymdownx.snippets
# https://squidfunk.github.io/mkdocs-material/reference/formatting/#adding-keyboard-keys
- pymdownx.keys
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist
- pymdownx.tasklist:
custom_checkbox: true
# allows the usage of content tabs, a simple way to group related content
- pymdownx.tabbed:
alternate_style: true
# arbitrary nesting of code and content blocks inside each other
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# generates a Table of Contents from a Markdown document with [TOC]
- toc:
permalink: '¤'
baselevel: 1
# toc_depth: 4
# automatically inlines bundled and custom icons and emojis
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#additional-icons
options:
custom_icons:
- overrides/.icons
# }}}
# {{{ Extensions to mkdocs - some of them are used by material theme
plugins:
# https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin
- privacy:
assets_fetch: true
assets_fetch_dir: assets/externals
assets_exclude:
- badge.fury.io/*
- img.shields.io/*
- cdn.jsdelivr.net/npm/mathjax@3/*
- giscus.app/*
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
- search:
lang: en
# https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
- awesome-pages
# https://github.com/fralau/mkdocs_macros_plugin
# - macros
# https://github.com/midnightprioriem/mkdocs-autolinks-plugin
- autolinks
# https://github.com/blueswen/mkdocs-glightbox
- glightbox
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
- social:
cards: true
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
- tags:
listings_tags_sort_by: !!python/name:material.plugins.tags.tag_name_casefold
listings_sort_by: !!python/name:material.plugins.tags.item_title
# https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
- git-revision-date-localized:
enable_creation_date: true
type: timeago
# https://github.com/byrnereese/mkdocs-swagger-ui
# - swagger-ui-tag
# https://github.com/mkdocs/mkdocs-redirects
- redirects:
redirect_maps:
'explore-and-author/building-a-customized-user-interface/index.md': 'explore-and-author/graph-exploration/building-a-customized-user-interface/index.md'
'cmemc.md': 'automate/cmemc-command-line-interface/index.md'
# https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin
- meta
# }}}
# {{{ Less important mkdocs configuration
# https://www.mkdocs.org/user-guide/configuration/#watch
watch:
- overrides
# }}}