-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
122 lines (111 loc) · 4.16 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
# This configuration can be changed from this https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
# I will be putting comments on certain places where necessary
site_name: MkDocs Frinze Template
copyright: Copyright Frinze Erin Lapuz 2020
author: Frinze Erin Lapuz # remove this if you removed the override/partial
author_website: https://frinzelapuz.vercel.app/ # remove this if you removed the override/partial
repo_url: https://github.com/frinzekt/mkdocs-frinze-template/
# This uri refers to the github path to edit, change this if you branch is different in name
edit_uri: edit/main/docs/
theme:
name: material
custom_dir: overrides # remove this if you removed the override/partial
palette:
- media: "(prefers-color-scheme: light)" # below here is a palette for light mode
primary: teal
scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)" # below here is a palette for dark mode
primary: teal
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
logo: images/docs.png
favicon: images/docs.png
features: # Refer to https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
- navigation.instant
# - navigation.tabs
plugins:
- search
- mermaid2:
version: 8.8.2
arguments:
theme: white # change this as you see fit - ["white", "dark"]
# This is the PDF Generator of the documentation
# More information here https://github.com/orzih/mkdocs-with-pdf
# note at this current moment, to use this feature, the following must be met
# - Relative Path only with images
# - Mermaid Markdown doesn't render at the moment in PDF
- with-pdf:
author: Frinze Erin Lapuz
cover_title: MkDocs Frinze Template
cover_subtitle: Making documentation easier
cover_logo: ./docs/images/docs.png
enabled_if_env: ENABLE_PDF_EXPORT # This prevents generation of pdf when using `mkdocs serve` because it takes a long time. This will however generate the PDF when the environment variable is setup OR in the github action
# These are markdown extensions I have included that makes the documentation look nicer
# These extensions are from here https://facelessuser.github.io/pymdown-extensions/
markdown_extensions:
- admonition
- attr_list
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.smartsymbols
- pymdownx.highlight:
use_pygments: true
linenums: true
- pymdownx.tabbed
- footnotes
- pymdownx.critic
- attr_list
- def_list
- pymdownx.tasklist
- pymdownx.keys
- pymdownx.mark
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- toc:
permalink: true
toc_depth: 4
- codehilite
- pymdownx.snippets:
base_path: docs
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
extra:
social:
- icon: octicons/globe-16
link: https://frinzelapuz.vercel.app/
- icon: fontawesome/brands/github
link: https://github.com/frinzekt/
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/frinze-erin-lapuz/
- icon: fontawesome/solid/paper-plane
link: mailto:frinze.lapuz@gmail.com
# Add google Analytics when you need it
# Remove this if you dont need it
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/
google_analytics:
- UA-162451015-2
- auto
# This is the extra javascript included in the documentation
extra_javascript:
- https://unpkg.com/mermaid@8.8.2/dist/mermaid.min.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# If you want to put extra CSS
# extra_css:
# -
# This is where you adjust the hierarchy if the documentation
# You can erase this if you want. If you erase this, Mkdocs will alphabetically sort your documentation
nav:
- Overview: index.md
- Extensions Installed Overview: extensions.md
- Automatic Site Deployment: github-action.md