-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
95 lines (84 loc) · 2.93 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
# ###############################
# Main config file for MkDocs.
# ###############################
#
# To run:
# mkdocs serve
# More help: https://www.holunda.io/camunda-bpm-taskpool/developer-guide/project-setup.html#build-documentation
# ###############################
site_name: Avro Kotlin
site_url: https://avro-kotlin.toolisticon.io/
site_author: Holisticon Crafters
site_description: >-
Avro Kotlin provides utilities to improve working experience with Apache Avro and Kotlin.
copyright: Copyright © 2024, Holisticon AG
use_directory_urls: false
# Repository
repo_name: toolisticon/avro-kotlin
repo_url: https://github.com/toolisticon/avro-kotlin/
edit_uri: edit/develop/docs/
markdown_extensions:
- attr_list
- toc:
permalink: "#"
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.details
- admonition
theme:
name: material
features:
- navigation.instant # When instant loading is enabled, clicks on all internal links will be intercepted and dispatched via XHR without fully reloading the page
- navigation.tabs # add top level nav items into a horizoneal menu
- navigation.tabs.sticky # make horizontal menu sticky (insider feature)
- navigation.sections
- navigation.top # add "navigate to top" page icon on bottom left
- toc.integrate # integrate site TOC into the menu on the left
logo: assets/img/logo.svg
icon:
repo: fontawesome/brands/github
font:
text: Roboto
code: Roboto Mono
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
extra_css: [ assets/css/extra.css ]
extra:
social:
- icon: fontawesome/brands/twitter
name: Holisticon on Twitter
link: https://twitter.com/holisticon
- icon: fontawesome/brands/medium
name: Holisticon Crafters on Medium
link: https://medium.com/holisticon-consultants/tagged/mpb
version:
provider: mike
plugins:
- search
- mike:
# these fields are all optional; the defaults are as below...
version_selector: true # set to false, in order to leave out the version selector
css_dir: css # the directory to put the version selector's CSS
javascript_dir: js # the directory to put the version selector's JS
canonical_version: null # the version for <link rel="canonical">; `null`
# uses the version specified via `mike deploy`
- git-revision-date-localized:
type: date
fallback_to_build_date: true
nav:
- Home: index.md
- Getting Started: getting-started/index.md
- Reference:
- Reference Overview: reference-guide/index.md
- Developers:
- Contribution: developer-guide/contribution.md
- Project Setup: developer-guide/project-setup.md