/
mkdocs.yml
130 lines (104 loc) · 4.36 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
# Basic configuration
site_name: Chouffy's Notes
site_url: https://chouffy.net
repo_url: https://github.com/Chouffy/chouffy.github.io
repo_name: Edit on GitHub
site_description: This website contains tips & tricks about multiple things I've learned over the years.
site_author: Chouffy
copyright: This work is licensed under CC BY 4.0.
# Enable code action
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
edit_uri: edit/main/docs/
markdown_extensions:
# Add anchor in each title for better reference
# https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
- toc:
permalink: true
# Manage table
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#tables
#- tables
theme:
name: material
# Override some pages, like 404
# https://squidfunk.github.io/mkdocs-material/customization/#setup-and-theme-structure
custom_dir: overrides
# Specify website language. Used by search
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/
language: en
features:
# Instant navigation
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
- navigation.instant
#- navigation.instant.prefetch
- navigation.instant.progress
# Currently viewed anchor update the URL
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-tracking
- navigation.tracking
# Add tabs which represents top level folder
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections-with-sections
- navigation.tabs
# Follow the displayed header in the ToC
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following
- toc.follow
# Integrate the right panel (ToC) into the left one
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-integration
#- toc.integrate
# Display next word suggestion in search
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions
- search.suggest
# Display View and Edit button linked to source code
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
- content.action.view
- content.action.edit
# Set `index.md` in each docs folder as the header of the section
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
- navigation.indexes
# Define two colors for the website
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
# Define custom scheme
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: grey
toggle:
icon: material/brightness-4
name: Switch to system preference
icon:
# Custom repo icon https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-icon
repo: fontawesome/brands/github
# Custom logo https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo
logo: assets/icon.svg
# Define custom favicon https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon
favicon: assets/icon.svg
extra_css:
# Needed for color
- stylesheets/color_scheme.css
plugins:
# Transform [[wikilinks]] into [relative](links)
# https://github.com/Lisandra-dev/mkdocs-ezlinked-plugin
# pip install mkdocs-ezlinked-plugin
- ezlinks:
wikilinks: true
# Enable Search
# https://squidfunk.github.io/mkdocs-material/plugins/search/
- search
# Show the latest modified date
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-dates
# pip install mkdocs-git-revision-date-localized-plugin
- git-revision-date-localized:
type: timeago
enable_creation_date: true