mkdocs.yml

site_name: Yanedie | Notebook
repo_name: yanedie.github.io
repo_url: https://github.com/yanedie/yanedie.github.io
copyright: Copyright © 2024 Yanedie

use_directory_urls: false

extra_css:
  - stylesheets/extra.css
  - stylesheets/photo.css
extra_javascript:
  - javascripts/photo.js
  - javascripts/tablesort.js
  - javascripts/open-in-new-tab.js
  - javascripts/jquery.dataTables.min.js

plugins:
  - search
  - literate-nav:
      nav_file: nav.md
  - callouts
  # - statistics
  - blog:
      blog_toc: true
      categories_name: 标签
      categories_toc: true
  - tags:
      tags_file: tags.md
  # - macros

hooks:
  - hooks/fancybox.py
  - hooks/utils.py
  # - my_hooks.py

exclude_docs: |
  assets/templates/post.md

watch:
  - hooks

theme:
  language: zh
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: red
      toggle:
        icon: material/brightness-7
        name: 切换至夜间模式

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: 切换至日间模式
  custom_dir: overrides
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - content.code.copy
    - content.tooltips
    - navigation.top
    - navigation.tabs
    # - navigation.expand
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.footer
    - toc.follow

markdown_extensions:
  - nl2br
  # 安全说明 用法：https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage
  - admonition
  # 向几乎每个 Markdown 内联和块级元素添加 HTML 属性和 CSS 类
  - attr_list
  # 向文档添加定义列表 用法：https://squidfunk.github.io/mkdocs-material/reference/lists/#using-definition-lists
  - def_list
  # 脚注 用法：https://squidfunk.github.io/mkdocs-material/reference/footnotes/
  - footnotes
  # 允许在 HTML 内部编写 Markdown
  - md_in_html
  # 自动从文档中生成一个目录
  - toc:
      permalink: "#"
  # 添加了在 Markdown 中创建表的功能
  - tables
  # 改进了加粗和斜体的 MD 语法检测
  - pymdownx.betterem
  # 添加了突出显示文本和使用简单语法定义子标和上标的功能 用法：https://squidfunk.github.io/mkdocs-material/reference/formatting/#highlighting-text，https://squidfunk.github.io/mkdocs-material/reference/formatting/#sub-and-superscripts
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  # 允许使用 Critic Markup 来突出显示文档中添加、删除或更新的部分
  - pymdownx.critic
  # 增强了 Admonition 扩展，使生成的调用可折叠
  - pymdownx.details
  # 使用表情符号:
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator:
        !!python/name:material.extensions.emoji.to_svg # 突出显示代码块和内联代码块的语法


  - pymdownx.highlight:
      auto_title: false # 显示代码名称
      linenums: true # 添加代码块行号
      pygments_lang_class: true
  # 允许任意嵌套代码和内容块，包括警告、选项卡、列表和所有其他元素。
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format:
            !!python/name:pymdownx.superfences.fence_code_format # 呈现键盘键和组合键 用法：https://squidfunk.github.io/mkdocs-material/reference/formatting/#adding-keyboard-keys


  - pymdownx.keys
  # 页面内部 tab
  - pymdownx.tabbed:
      alternate_style: true
      # slugify: !!python/object/apply:pymdownx.slugs.slugify
      #   kwds:
      #     case: lower
  # 任务列表 用法：https://squidfunk.github.io/mkdocs-material/reference/lists/#using-task-lists
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.snippets:
      url_download: true