mkdocs.yml

site_name: 个人笔记
site_description: 记录日常工作、学习的一些文档，收藏看到好的资源等
site_url: https://wgzhao.github.io/notes/
site_author: wgzhao
repo_name: wgzhao/notes
repo_url: https://github.com/wgzhao/notes
edit_uri: ""

copyright: Copyright © wgzhao
theme:
  name: material
  language: zh
  icon:
    repo: fontawesome/brands/github
  palette:
    # - primary: indigo
    - scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.instant # clicks on all internal links will be intercepted
    - navigation.indexes
    - navigation.expand
    - content.code.annotate
    - content.tabs.link
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.tracking # the URL in the address bar is automatically updated with the active anchor as highlighted in the table of contents
    - search.highlight
    - search.share
    - search.suggest
    # - toc.integrate
    - header.autohide
    - announce.dismiss
    - toc.integrate
  font:
    text: Roboto


plugins:
  - search:
  - tags:
      tags_file: tags.md
  - rss:
      abstract_chars_count: -1  # -1 for full content
      abstract_delimiter: <!-- more -->
      categories:
        - tags
      comments_path: "#__comments"
      date_from_meta:
        as_creation: "date"
        as_update: "git"
        datetime_format: "%Y-%m-%d %H:%M"
        default_timezone: Asia/Chongqing
        default_time: "09:30"
      enabled: true
      feed_ttl: 1440
      image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
      length: 20
      pretty_print: false
      match_path: ".*"
      url_parameters:
        utm_source: "documentation"
        utm_medium: "RSS"
        utm_campaign: "feed-syndication"
extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/01mlsx
    - icon: fontawesome/brands/github
      link: https://github.com/wgzhao

# Extensions
markdown_extensions:
  - admonition # adds support for admonitions
  - abbr # adds the ability to add a small tooltip to an element
  - attr_list # allows to add HTML attributes and CSS classes to almost every Markdown inline- and block-level element with a special syntax
  - def_list # adds the ability to add definition lists
  - footnotes
  - meta
  - md_in_html # allows for writing Markdown inside of HTML
  - toc: # automatically generates a table of contents from a document
      permalink: true
      title: On this page
      toc_depth: 3
  - tables: #  adds the ability to create tables in Markdown by using a simple syntax
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret # add the ability to highlight text and define sub- and superscript using a simple syntax
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: wgzhao
      repo: notes
  - pymdownx.smartsymbols
  - pymdownx.superfences:
     custom_fences:
       - name: mermaid
         class: mermaid
         format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path:
        - docs/assets
      check_paths: false
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - mkdocs_graphviz

# preview control
use_directory_urls: true

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML
  - https://cdn.jsdelivr.net/gh/rod2ik/cdn@main/mkdocs/javascripts/mkdocs-graphviz.js

extra_css:
  - css/extra.css