-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
mkdocs.yml
190 lines (178 loc) · 6.07 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
# Project information
site_name: !ENV [MKDOCS_SITE_NAME, "Geotribu in English"]
site_description: >-
Independent and collaborative website on free and open-source geomatics.
Articles, tutorials, news about GIS, mapping, data visualization...
site_author: !ENV [MKDOCS_SITE_AUTHOR, "Geotribu"]
site_url: !ENV [MKDOCS_SITE_URL, "https://blog.geotribu.net/"]
copyright:
!ENV [MKDOCS_SITE_COPYRIGHT, '<span class="copyleft">©</span> Geotribu']
# Repository
repo_name: !ENV [GITHUB_REPOSITORY, "geotribu/english-blog"]
repo_url: !ENV [MKDOCS_REPO_URL, "https://github.com/geotribu/english-blog"]
edit_uri: !ENV [MKDOCS_EDIT_URI, "edit/main/content"]
# Custom folder structure
docs_dir: !ENV [MKDOCS_SOURCE_DIR, "./content"]
site_dir: !ENV [MKDOCS_OUTPUT_DIR, "./build/mkdocs/site"]
# Plugins
plugins:
- blog:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_BLOG, true]
archive_name: By dates
archive_url_date_format: yyyy/MM
archive_url_format: "{date}"
authors_file: "{blog}/.authors.yml"
authors_profiles: true
blog_dir: .
draft_on_serve: !ENV [MKDOCS_PLUGIN_BLOG_DRAFT_SERVE, true]
draft_if_future_date: !ENV [MKDOCS_PLUGIN_BLOG_DRAFT_FUTURE_DATE, false]
pagination_format: "$link_first $link_previous ~2~ $link_next $link_last"
post_date_format: long
- privacy:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_PRIVACY, true]
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/*
# external
- cdnjs.cloudflare.com/ajax/libs/twemoji/*
- cdn.jsdelivr.net/**/*/twemoji*
- github.com/**/*.gif
- i.imgur.com/*
- raw.githubusercontent.com/*
- twemoji.maxcdn.com/*
- upload.wikimedia.org/*
- user-images.githubusercontent.com/**/*.gif
- search:
lang: en
- social:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL, true]
cache_dir: !ENV [MKDOCS_PLUGIN_SOCIAL_CACHE_DIR, .cache/plugins/social]
cards: !ENV [MKDOCS_ENABLE_PLUGIN_SOCIAL_CARDS, true]
cards_layout_options:
background_color: "#00000000"
background_image: content/theme/assets/images/geotribu/background_geotribu.png
color: "#56c29e"
font_family: Ubuntu
- 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
- typeset:
enabled: !ENV [MKDOCS_ENABLE_PLUGIN_TYPESET, true]
# Theme
theme:
name: "material"
custom_dir: "./content/theme/"
favicon: theme/assets/images/geotribu/geotribu_logo_tipi_seul_carre.png
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.footnote.tooltips
- content.tabs.link
- content.tooltips
- header.autohide
- navigation.indexes
- navigation.path
# - navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
font:
code: Ubuntu Mono
text: Ubuntu
language: en
logo: theme/assets/images/geotribu/geotribu_logo_tipi_seul_carre.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
geotribu_main_site: https://geotribu.fr/
url_contribuer: https://contribuer.geotribu.fr/
extra_css:
- "theme/assets/stylesheets/extra.css"
# 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.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.smartsymbols
# https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
- pymdownx.snippets:
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: "#"
nav:
- "Blog": index.md
- "🤓 About": about.md
- "🤲 Want to blog here?": contributing.md
- "🔖 By tags": tags.md
- "🔄 RSS feed": /feed_rss_created.xml
- "🇫🇷 Main website": https://geotribu.fr/