mkdocs.yml

INHERIT: ./mkdocs-redirects.yml

site_name: 总结
site_description: 各种课程的总结、随记等。
site_url: https://ydx-2147483647.github.io/summaries/
repo_url: https://github.com/YDX-2147483647/summaries
repo_name: YDX-2147483647/summaries
edit_uri: "blob/main/docs/"

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      primary: teal
      toggle:
        icon: material/brightness-auto
        name: 切换到亮色
    - media: "(prefers-color-scheme: light)"
      primary: teal
      scheme: default
      toggle:
        icon: material/brightness-7
        name: 切换到暗色
    - media: "(prefers-color-scheme: dark)"
      primary: teal
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: 自动设置亮暗
  # TODO: There is no way to tell territory code to RSS plugin now.
  # https://github.com/Guts/mkdocs-rss-plugin/issues/176
  # We should change to `zh_CN` when Material theme switches to locale.
  # https://github.com/squidfunk/mkdocs-material/discussions/6453
  language: zh
  custom_dir: overrides
  features:
    - navigation.instant
    - navigation.prune
    - navigation.top
    - navigation.tabs
    - content.action.view
    - content.action.edit
    - search.highlight
    - search.share
  font: false
  logo: assets/logo.svg
  favicon: assets/logo.png
  # U+1F5C3 (🗃️) from [twemoji](https://twemoji.twitter.com/).
  # https://raw.githubusercontent.com/twitter/twemoji/master/assets/svg/1f5c3.svg
  # https://emojipedia.org/card-file-box/
  # https://util.unicode.org/UnicodeJsps/character.jsp?a=1F5C3

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds: {}
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.mark
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tilde
  - mdx_truly_sane_lists

plugins:
  # Default plugins
  search:
    separator: '[\s\u200b\-]'
    # 零宽空格用于中文分词

  # Extra plugins
  rss:
    # Disable RSS for faster build times in development
    enabled: !ENV [MKDOCS_ENABLE_RSS_PLUGIN, true]
    # Only include `<h1>` in abstract
    abstract_delimiter: "\n"
    image: https://ydx-2147483647.github.io/summaries/assets/logo.png
  redirects: {} # inherited

hooks:
  - hooks/relationship.py

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

extra_css:
  - stylesheets/extra.css

extra:
  analytics:
    provider: custom
    property: ZwSg9rf6GA
  comments: true
  social:
    - icon: simple/rss
      link: https://ydx-2147483647.github.io/summaries/feed_rss_updated.xml
      name: RSS