adding more mkdocs customization for beautification

simingy · simingy · commit fe910d89f834 · 2022-02-28T17:58:51.000-05:00
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,11 +1,33 @@
 site_name: How To Cook
+
+# Repository
+repo_name: Anduin2017/HowToCook
+repo_url: https://github.com/Anduin2017/HowToCook
+edit_uri: ""
+
 use_directory_urls: true
 docs_dir: .
 theme:
   name: material
   language: zh
   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:
     - media: "(prefers-color-scheme: light)" 
       scheme: default
@@ -18,7 +40,34 @@ theme:
       toggle:
         icon: material/weather-night
         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:
   - same-dir
   - search
+  - minify:
+      minify_html: true
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
 mkdocs-material
 mkdocs-same-dir
+mkdocs-minify-plugin

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`mkdocs-material`
`2`	`2`	`mkdocs-same-dir`
	`3`	`+mkdocs-minify-plugin`