-
Notifications
You must be signed in to change notification settings - Fork 15
/
mkdocs.yml
196 lines (184 loc) · 5.7 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
site_name: Gothic Modding Community
site_url: !ENV [GMC_DEV_URL, 'https://gothic-modding-community.github.io/gmc/']
site_description: 'Gothic Modding Community is a collection of helpful resources for modding Gothic and Risen games.'
repo_name: Gothic-Modding-Community/gmc
repo_url: https://github.com/Gothic-Modding-Community/gmc/
edit_uri: edit/main/docs/
watch:
- overrides/assets
- overrides/.snippets
- overrides/main.html
hooks:
- overrides/.hooks/theme_overrides_manager.py
- overrides/.hooks/language_flags.py
- overrides/.hooks/git_redirects.py
- overrides/.hooks/all_plugin_patch.py
- overrides/.hooks/preferences.py
theme:
name: material
custom_dir: overrides
favicon: assets/images/gmc_logo.png
logo: assets/images/gmc_logo.png
font:
code: JetBrains Mono
icon:
repo: fontawesome/brands/github
alternate: material/earth
palette:
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: black
accent: light blue
scheme: slate
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
primary: black
scheme: default
accent: indigo
toggle:
icon: material/lightbulb
name: Switch to dark mode
features:
- navigation.tabs
- navigation.indexes
- navigation.footer
- content.code.copy
- content.action.edit
- content.action.view
- content.tooltips
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/extra.js
extra:
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/mCpS5b5SUY
name: Gothic Modding Community Discord Server
- icon: fontawesome/brands/github
link: https://github.com/Gothic-Modding-Community/gmc
name: Gothic Modding Community GitHub repository
markdown_extensions:
- toc:
permalink: ""
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- admonition
- pymdownx.caret
- pymdownx.details
- pymdownx.highlight:
use_pygments: true
linenums: true
anchor_linenums: true
# This sets the same ID for the <a> and <span> tags,
# it's required for the <a> links to work and to allow <span> highlighting via JavaScript
line_anchors: example
line_spans: example
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: ['./overrides/.snippets/']
check_paths: true
url_download: true
url_max_size: 5000000
url_timeout: 5
- footnotes
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.smartsymbols
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
- search
- awesome-pages:
order: asc
sort_type: natural
order_by: title
- mkdocs-video:
css_style:
width: "100%"
height: "100%"
- minify:
minify_html: !ENV [GMC_ENABLE_ON_PUBLISH, False]
minify_css: !ENV [GMC_ENABLE_ON_PUBLISH, False]
minify_js: !ENV [GMC_ENABLE_ON_PUBLISH, False]
cache_safe: !ENV [GMC_ENABLE_ON_PUBLISH, False]
htmlmin_opts:
remove_comments: true
css_files:
- assets/stylesheets/extra.css
js_files:
- assets/javascripts/extra.js
- i18n:
build_only_locale: !ENV [GMC_DEV_LOCALE]
docs_structure: suffix
languages:
- name: en - English
locale: en
default: true
build: true
nav_translations:
Afsp: AFSP
Anims: Animations
Contribute: How To Contribute
Daedalus tools: Daedalus
General info: General information
Genome: Genome (G3/R1)
Lego: LeGo
Vdfs tools: VDFS
Zengin: ZenGin (G1/G2)
Zgamepad: zGamePad
Zparserextender: zParserExtender
- name: pl - Polski
locale: pl
build: !ENV [GMC_ENABLE_ON_PUBLISH, GMC_BUILD_ALTERNATES, False]
site_description: 'Gothic Modding Community to zbiór pomocnych materiałów do modowania gier Gothic i Risen.'
nav_translations:
Anims: Animacje
Applications: Zastosowania
Classes: Klasy
Contribute: Jak Się Udzielić
Examples: Przykłady
Extenders: Extendery
Extensions: Rozszerzenia
Functions: Funkcje
General info: Informacje ogólne
Home: Strona Główna
Plugins: Pluginy
Scripts: Skrypty
Sound: Dźwięk
Standalone: Samodzielne
Syntax extensions: Rozszerzenia składni
Tools: Narzędzia
Tutorials: Poradniki
Various: Różne
Worlds: Światy
- name: cs - Čeština
locale: cs
build: !ENV [GMC_ENABLE_ON_PUBLISH, GMC_BUILD_ALTERNATES, False]
site_description: 'Dokumentace, návody a články zaměřené na modování her Gothic a Risen.'
- git-revision-date-localized:
enabled: !ENV [GMC_ENABLE_ON_PUBLISH, False]
type: iso_datetime
timezone: Europe/Warsaw
exclude:
- index*.md
- preferences*.md
- genome/index*.md
- zengin/index*.md
- redirects:
# Empty dict to fill with the `meta_redirects.py` hook.
redirect_maps: {}
- social:
enabled: !ENV [GMC_ENABLE_ON_PUBLISH, False]