-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
119 lines (109 loc) · 3.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
site_name: RedKB
site_description: My personal knowledgebase
# site_url: https://github.com/redjax/red-utils
repo_name: redjax/redkb
repo_url: https://github.com/redjax/redkb
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/redjax
## True=show "Made with Material for MkDocs", false=hide
generator: false
exclude_docs: |
drafts/
**/drafts/
use_directory_urls: false
theme:
name: material
highlightjs: true
icon:
repo: fontawesome/brands/git
font:
text: Open Sans
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: amber
toggle:
icon: material/weather-night
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
primary: black
accent: amber
features:
- content.code.annotate
- content.code.copy
- content.tabs.link
- content.code.select
# - header.autohide
- navigation.footer
- navigation.indexes
- navigation.path
- navigation.tabs
- navigation.tracking
# - navigation.sections
- search.share
- search.suggest
- search.highlight
- toc.follow
plugins:
- search
- literate-nav:
nav_file: SUMMARY.md
- section-index
## For better image support
- glightbox
- tags:
tags_file: tags.md
# tags_heirarchy: true # Only available in "insiders" edition
- git-revision-date-localized:
## Options: ["date", "datetime", "iso_date", "iso_datetime", "timeago"]
type: timeago
## Show/hide creaetion date of file associated with page.
# Appears next to last updated date at bottom of page
enable_creation_date: true
## Fallback to build date if mkdocs build is run outside of a git repo
fallback_to_build_date: true
## Check rendered HTML for broken links, set ENABLED_HTMLPROOFEER=True to enable
# then run mkdocs serve command.
- htmlproofer:
enabled: !ENV [ENABLED_HTMLPROOFER, False]
warn_on_ignored_urls: true
validate_external_urls: True
validate_rendered_template: True
## Enable offline version of site. Breaks many features.
# - offline
markdown_extensions:
## Add footnotes to marked-up abbreviations to provide extra context.
# https://squidfunk.github.io/mkdocs-material/reference/tooltips/#adding-abbreviations
- abbr
- admonition
- markdown_include.include:
base_path: .
- pymdownx.inlinehilite
- pymdownx.snippets:
## Add additional snippets, like *[Annotation]: ... glossaries
auto_append:
- includes/abbreviations.md
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
use_pygments: true
pygments_lang_class: true
## Enable markdown checklists, - [ ]/- [x]
- def_list
- pymdownx.tasklist:
custom_checkbox: true
## Handle images
- attr_list
- md_in_html
## Render Markdown tables
- tables