refine config

config/mkdocs.base.yml

@@ -17,3 +17,10 @@ copyright: >
   <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank">
       Material for MkDocs
   </a>
+
+watch:
+  - ../docs
+  - ../config
+  - ../overrides
+  - ../includes
+

config/mkdocs.extensions.yml

@@ -0,0 +1,64 @@
+INHERIT: ./mkdocs.base.yml
+
+markdown_extensions:
+  - abbr  
+  - pymdownx.snippets:
+      check_paths: true
+      auto_append:
+        - includes/abbreviations.md
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - toc:
+      permalink: true
+      title: On this page
+      permalink_title: Anchor link to this section for reference
+      toc_depth: 3
+      slugify: !!python/object/apply:pymdownx.slugs.slugify
+        kwds:
+          case: lower   
+  - tables
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format    
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.mark
+  - pymdownx.tilde
+  - pymdownx.critic:
+      mode: view
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      options:
+        custom_icons:
+          - overrides/.icons
+  - pymdownx.highlight:
+      use_pygments: true
+      pygments_lang_class: true
+      auto_title: true
+      linenums: true
+      linenums_style: pymdownx-inline
+      anchor_linenums: true
+      line_spans: __span     
+  - pymdownx.inlinehilite             
+  - pymdownx.keys
+  - pymdownx.magiclink
+  - pymdownx.smartsymbols
+  - pymdownx.tabbed:
+      alternate_style: true
+      combine_header_slug: true
+      slugify: !!python/object/apply:pymdownx.slugs.slugify
+        kwds:
+          case: lower      
+  - pymdownx.tasklist:
+      custom_checkbox: true    
+      clickable_checkbox: true      

config/mkdocs.extra.js.yml

@@ -0,0 +1,6 @@
+INHERIT: ./mkdocs.extensions.yml
+
+extra_javascript:
+  - javascripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

config/mkdocs.extra.yml

@@ -1,15 +1,4 @@
-INHERIT: ./mkdocs.base.yml
-
-plugins:
-  - search
-  - offline
-  # - mike
-  # - blog
-  # - meta
-  # - optimize
-  # - blog
-  # - social
-  # - privacy
+INHERIT: ./mkdocs.extra.js.yml
 
 extra:
   consent:
@@ -30,54 +19,4 @@ extra:
       link: https://github.com/wangzhizhou
   generator: false
   # version:
-  #   provider: mike
-
-markdown_extensions:
-  - abbr
-  - admonition
-  - attr_list
-  - def_list
-  - footnotes
-  - md_in_html
-  - tables
-  - toc:
-      permalink: true
-      title: On this page
-      permalink_title: Anchor link to this section for reference
-  - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
-      options:
-        custom_icons:
-          - overrides/.icons
-  - pymdownx.arithmatex:
-      generic: true
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.mark
-  - pymdownx.tilde
-  - pymdownx.critic
-  - pymdownx.details
-  - pymdownx.magiclink
-  - pymdownx.smartsymbols
-  - pymdownx.keys
-  - pymdownx.highlight:
-      anchor_linenums: true
-      linenums: true
-      use_pygments: true
-      auto_title: true
-      linenums_style: pymdownx-inline
-      pygments_lang_class: true
-      line_spans: __span
-  - pymdownx.inlinehilite
-  - pymdownx.snippets
-  - pymdownx.superfences
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tabbed:
-      alternate_style: true
-
-extra_javascript:
-  - https://polyfill.io/v3/polyfill.min.js?features=es6
-  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+  #   provider: mike

config/mkdocs.plugins.yml

@@ -0,0 +1,12 @@
+INHERIT: ./mkdocs.extra.yml
+
+plugins:
+  - search
+  - offline
+  # - mike
+  # - blog
+  # - meta
+  # - optimize
+  # - blog
+  # - social
+  # - privacy

config/mkdocs.theme.yml

@@ -1,4 +1,4 @@
-INHERIT: ./mkdocs.extra.yml
+INHERIT: ./mkdocs.plugins.yml
 
 theme: 
   name: material

docs/javascripts/mathjax.js

@@ -0,0 +1,16 @@
+window.MathJax = {
+    tex: {
+      inlineMath: [["\\(", "\\)"]],
+      displayMath: [["\\[", "\\]"]],
+      processEscapes: true,
+      processEnvironments: true
+    },
+    options: {
+      ignoreHtmlClass: ".*|",
+      processHtmlClass: "arithmatex"
+    }
+  };
+
+  document$.subscribe(() => {
+    MathJax.typesetPromise()
+  })

includes/abbreviations.md

@@ -0,0 +1,2 @@
+*[Vapor]: Vapor is an HTTP web framework for Swift. It provides a beautifully expressive and easy-to-use foundation for your next website, API, or cloud project.
+*[Swift]: Swift is a general-purpose programming language that's approachable for newcomers and powerful for experts. It is fast, modern, safe, and a joy to write.