adding more mkdocs customization for beautification

This commit is contained in:
Siming Yuan 2022-02-28 17:58:51 -05:00 committed by Siming Yuan
parent 9878a16523
commit fe910d89f8
2 changed files with 51 additions and 1 deletions

View File

@ -1,11 +1,33 @@
site_name: How To Cook site_name: How To Cook
# Repository
repo_name: Anduin2017/HowToCook
repo_url: https://github.com/Anduin2017/HowToCook
edit_uri: ""
use_directory_urls: true use_directory_urls: true
docs_dir: . docs_dir: .
theme: theme:
name: material name: material
language: zh language: zh
features: features:
- navigation.instant - content.code.annotate
# - content.tabs.link
# - header.autohide
# - navigation.expand
- navigation.indexes
# - navigation.instant
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
search_index_only: true
palette: palette:
- media: "(prefers-color-scheme: light)" - media: "(prefers-color-scheme: light)"
scheme: default scheme: default
@ -18,7 +40,34 @@ theme:
toggle: toggle:
icon: material/weather-night icon: material/weather-night
name: Switch to light mode name: Switch to light mode
icon:
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- abbr
- pymdownx.snippets
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- attr_list
plugins: plugins:
- same-dir - same-dir
- search - search
- minify:
minify_html: true

View File

@ -1,2 +1,3 @@
mkdocs-material mkdocs-material
mkdocs-same-dir mkdocs-same-dir
mkdocs-minify-plugin