-
-
Notifications
You must be signed in to change notification settings - Fork 79
/
mkdocs.yml
260 lines (246 loc) · 7.83 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
# Project information
site_name: !ENV [MKDOCS_SITE_NAME, "Geotribu"]
site_description: >-
Site indépendant de veille sur la géomatique libre et open source.
Articles, tutoriels et revues de presse (#GeoRDP) sur
l'information géographique, les SIG, la cartographie, la représentation des données...
site_author: !ENV [MKDOCS_SITE_AUTHOR, "Geotribu"]
site_url: !ENV [MKDOCS_SITE_URL, "https://geotribu.fr/"]
copyright:
!ENV [MKDOCS_SITE_COPYRIGHT, '<span class="copyleft">©</span> Geotribu']
# Repository
repo_name: !ENV [GITHUB_REPOSITORY, "geotribu/website"]
repo_url: !ENV [MKDOCS_REPO_URL, "https://github.com/geotribu/website"]
edit_uri: !ENV [MKDOCS_EDIT_URI, "edit/master/content"]
# Custom folder structure
docs_dir: !ENV [MKDOCS_SOURCE_DIR, "./content"]
site_dir: !ENV [MKDOCS_OUTPUT_DIR, "./build/mkdocs/site"]
# Scripts pendant le build
hooks:
# - hooks/mkdocs/G002_check_images_size.py
- hooks/mkdocs/G003_social_cards_adapter.py
- hooks/mkdocs/G005_jinja_filters.py
- hooks/mkdocs/G006_authors_block.py
# Plugins
plugins:
- awesome-pages
- exclude:
glob:
- "*/templates/*"
- "*.yml"
- git-authors:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_GIT_AUTHORS, false]
exclude:
- index.md
show_contribution: true
show_email_address: false
- git-revision-date-localized:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_GIT_DATES, false]
enable_creation_date: true
fallback_to_build_date: true
locale: fr
- meta:
meta_file: "content/**/.meta.yml"
- minify:
minify_css: true
css_files:
- theme/assets/stylesheets/extra.css
- theme/assets/stylesheets/homepage.css
minify_html: true
htmlmin_opts:
remove_comments: true
- search:
lang: fr
- macros:
include_dir: content/toc_nav_ignored/snippets
module_name: hooks/macros/custom_jinja
- tags:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_TAGS, true]
tags_sort_by: !!python/name:material.plugins.tags.tag_name_casefold
listings_sort_by: !!python/name:material.plugins.tags.item_url
- termynal
- privacy:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_PRIVACY, false]
cache_dir:
!ENV [MKDOCS_PLUGIN_PRIVACY_EXTERNAL_CACHE_DIR, .cache/plugins/privacy]
links_attr_map:
target: _blank
assets_exclude:
# mandatory - https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/
- cdn.jsdelivr.net/npm/mathjax@3/*
- giscus.app/*
# geotribu
- cdn.geotribu.fr/images/*
- cdn.geotribu.fr/img/*
- geotribu.net/*
- www.geotribu.net/*
- ks356007.kimsufi.com/*
# external
- baliz-geospatial.com/images/mediatheque/2008-08/*
- cdn.jsdelivr.net/**/*/twemoji*
- cdnjs.cloudflare.com/ajax/libs/twemoji/*
- github.com/**/*.gif
- i.imgur.com/*
- raw.githubusercontent.com/*
- sondekla.com/buid/widget/*
- cdnjs.cloudflare.com/ajax/libs/twemoji/*
- twemoji.maxcdn.com/*
- upload.wikimedia.org/*
- user-images.githubusercontent.com/**/*.gif
# to remove later:
- dev.openstreetmap.org/*
- www.portailsig.org/assets/images/*
- 88.191.39.115/*
- cdn.theatlanticcities.com/img/*
- boundlessgeo.com/*
- i3.codeplex.com/*
- drfhlmcehrc34.cloudfront.net/*
- social:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL, false]
cache_dir: !ENV [MKDOCS_PLUGIN_SOCIAL_CACHE_DIR, .cache/plugins/social]
cards: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL_CARDS, false]
cards_exclude:
- toc_nav_ignored/*.md
cards_layout_options:
background_color: "#00000000"
background_image: content/theme/assets/images/geotribu/background_geotribu.png
color: "#3e93a7"
font_family: Ubuntu
- typeset:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_TYPESET, true]
# Theme
theme:
name: "material"
custom_dir: "./content/theme/"
favicon: theme/assets/images/geotribu/logo_geotribu.png
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.footnote.tooltips
- content.tabs.link
- content.tooltips
- navigation.instant.preview
- navigation.path
- navigation.prune
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
font:
code: Ubuntu Mono
text: Ubuntu
language: fr
logo: theme/assets/images/geotribu/logo_geotribu.png
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Basculer en mode clair
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: "deep orange"
toggle:
icon: material/weather-sunny
name: Basculer en mode sombre
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue grey
accent: "deep orange"
toggle:
icon: material/weather-night
name: Basculer sur le réglage système
# Customization
extra:
comments_url: https://comments.geotribu.fr # isso url
url_contribuer: https://contribuer.geotribu.fr/
consent:
title: Consentement 🍪
actions:
- accept
- reject
description: >
Nous utilisons des cookies pour le goûter mais aussi pour vous proposer
des fonctionnalités (commentaires, thème clair ou sombre, etc.) et mesurer
l'audience du site.
extra_css:
- "theme/assets/stylesheets/extra.css"
extra_javascript:
- path: https://mastodon.social/embed.js
async: true
defer: true
- path: javascripts/mathjax.js
async: true
defer: true
- path: https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
async: true
defer: true
- path: https://platform.twitter.com/widgets.js
async: true
defer: true
# Extensions to enhance markdown - see: https://squidfunk.github.io/mkdocs-material/getting-started/#extensions
markdown_extensions:
- abbr
# Admonition - https://squidfunk.github.io/mkdocs-material/extensions/admonition/
- admonition
- attr_list
# Footnotes - https://squidfunk.github.io/mkdocs-material/reference/footnotes/
- footnotes
- md_in_html
# Metadata - https://squidfunk.github.io/mkdocs-material/extensions/metadata
- meta
# PyMdown extensions - https://squidfunk.github.io/mkdocs-material/extensions/pymdown/
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
use_pygments: true
- pymdownx.inlinehilite
- pymdownx.keys:
key_map:
shift: MAJ
delete: Suppr
caps-lock: "🄰 VER MAJ"
middle-button: "🖱️ clic molette"
- pymdownx.smartsymbols
- pymdownx.saneheaders
# https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
- pymdownx.snippets:
auto_append: [content/toc_nav_ignored/snippets/glossaire.md]
base_path:
- "."
check_paths: true
url_download: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Permalinks - https://squidfunk.github.io/mkdocs-material/extensions/permalinks/
- toc:
permalink: "#"
exclude_docs: |
toc_nav_ignored/*