mkdocs.yml 文件参考

最后更新于 2025/11/25。由于可能忘记更新,可能与现在使用的配置文件不同。

下面为本人主文件夹中的 mkdocs.yml 文件,省略 nav 部分,仅供参考:

YAML
site_url: https://catalan1906.github.io
site_name: Catalan1906 的杂货间

theme:
  name: material
  logo: files/icon.jpg
  favicon: files/icon.jpg
  features:
    - navigation.path
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - search.suggest
    - content.code.copy
    - content.code.select
  icon:
    annotation: material/plus-circle

plugins:
  - search

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - stylesheets/extra.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: 
  - tables
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      linenums: true
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.smartsymbols
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist: 
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.critic:
      mode: view
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower