Skip to content

Commit fe910d8

Browse files
committed
adding more mkdocs customization for beautification
1 parent 9878a16 commit fe910d8

File tree

2 files changed

+51
-1
lines changed

2 files changed

+51
-1
lines changed

mkdocs.yml

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
11
site_name: How To Cook
2+
3+
# Repository
4+
repo_name: Anduin2017/HowToCook
5+
repo_url: https://github.com/Anduin2017/HowToCook
6+
edit_uri: ""
7+
28
use_directory_urls: true
39
docs_dir: .
410
theme:
511
name: material
612
language: zh
713
features:
8-
- navigation.instant
14+
- content.code.annotate
15+
# - content.tabs.link
16+
# - header.autohide
17+
# - navigation.expand
18+
- navigation.indexes
19+
# - navigation.instant
20+
- navigation.sections
21+
- navigation.tabs
22+
# - navigation.tabs.sticky
23+
- navigation.top
24+
- navigation.tracking
25+
- search.highlight
26+
- search.share
27+
- search.suggest
28+
- toc.follow
29+
# - toc.integrate
30+
search_index_only: true
931
palette:
1032
- media: "(prefers-color-scheme: light)"
1133
scheme: default
@@ -18,7 +40,34 @@ theme:
1840
toggle:
1941
icon: material/weather-night
2042
name: Switch to light mode
43+
icon:
44+
admonition:
45+
note: octicons/tag-16
46+
abstract: octicons/checklist-16
47+
info: octicons/info-16
48+
tip: octicons/squirrel-16
49+
success: octicons/check-16
50+
question: octicons/question-16
51+
warning: octicons/alert-16
52+
failure: octicons/x-circle-16
53+
danger: octicons/zap-16
54+
bug: octicons/bug-16
55+
example: octicons/beaker-16
56+
quote: octicons/quote-16
2157

58+
markdown_extensions:
59+
- admonition
60+
- pymdownx.details
61+
- pymdownx.superfences
62+
- abbr
63+
- pymdownx.snippets
64+
- def_list
65+
- pymdownx.tasklist:
66+
custom_checkbox: true
67+
- attr_list
68+
2269
plugins:
2370
- same-dir
2471
- search
72+
- minify:
73+
minify_html: true

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
mkdocs-material
22
mkdocs-same-dir
3+
mkdocs-minify-plugin

0 commit comments

Comments
 (0)