mkdocs.yml

# project information
site_name: MinJoker's Notebook
site_url: https://note.minjoker.top
site_author: MinJoker
# repository
repo_name: MinJoker/note
repo_url: https://github.com/MinJoker/note
# copyright
copyright: Copyright <span style="font-family:Arial;">&copy;</span> 2023-2024 <a href="https://github.com/MinJoker" target="_blank">MinJoker</a>

# configuration
theme:
  name: material
  custom_dir: overrides
  language: zh
  icon:
    logo: octicons/infinity-16
  favicon: assets/images/link/minjoker.png
  font: false  # prevent typeface from loading from Google Fonts
  features:
    # - navigation.instant   # seems to cause formula rendering difficulty ( need one more refresh )
    # - navigation.tracking  # not good and has conflict with toc.js
    - navigation.tabs
    # - navigation.prune
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - header.autohide
    - content.code.copy
    - content.code.annotate
  palette:
    # palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: switch to dark mode
    # palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: switch to light mode

extra_css:
  - stylesheets/custom.css
  - stylesheets/counter.css
  - stylesheets/toc.css
  - stylesheets/katex.css
  - stylesheets/flink.css
  - https://cdn.tonycrane.cc/jbmono/jetbrainsmono.css
  - https://cdn.tonycrane.cc/lxgw/lxgwscreen.css
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css               # from mkdocs material
  - https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.css                      # from katex.org

extra_javascript:
  - javascripts/extra.js
  - javascripts/katex.js
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js                # from mkdocs material
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js  # from mkdocs material
  - https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.js                       # from katex.org
  - https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/contrib/auto-render.min.js         # from katex.org
  - https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/contrib/copy-tex.min.js            # from katex.org, help copy tex to clipboard

extra:
  analytics:
    provider: google
    property: G-TKGDGSQJ7M
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/MinJoker
    - icon: fontawesome/brands/google
      link: mailto:jokermin551008@gmail.com

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 4
      permalink_title: anchor link to this section for reference
  # Python Markdown Extensions
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  # https://github.com/blueswen/mkdocs-glightbox
  - glightbox
  # https://github.com/TonyCrane/mkdocs-statistics-plugin
  - statistics:
      words_per_minute: 250
      codelines_per_minute: 80
  # https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
  - git-revision-date-localized:
      type: datetime
      timezone: Asia/Shanghai
      locale: zh
      enable_creation_date: true
      exclude:
        - index.md
        - link.md
      strict: false
  # https://github.com/TonyCrane/mkdocs-heti-plugin
  - heti:
      disable_serve: false
  # https://github.com/JakubAndrysek/mkdocs-open-in-new-tab
  # - open-in-new-tab  # confict with toc.js

validation:
  absolute_links: ignore
  # unrecognized_links: ignore

# page tree
nav:
  - Home:
    - index.md
    - Friends: link.md

  - Courses:
    - courses/index.md
    - 数据结构基础:
      - courses/fds/index.md
      - courses/fds/note1.md
      - courses/fds/note2.md
      - courses/fds/note3.md
      - courses/fds/exercise.md
    - 高级数据结构与算法分析:
      - courses/ads/index.md
      - courses/ads/note1.md
      - courses/ads/note2.md
    - 数字逻辑设计:
      - courses/dd/index.md
      - courses/dd/note1.md
      - courses/dd/note2.md
      - courses/dd/note3.md
    - 计算机组成:
      - courses/co/index.md
      - courses/co/note1.md
      - courses/co/note2.md
    - 计算理论:
      - courses/toc/index.md
      - courses/toc/note1.md
      - courses/toc/exercise.md
    - 量子信息基础:
      - courses/qi/index.md
      - courses/qi/note1.md
      - courses/qi/note2.md
    - 概率论与数理统计:
      - courses/ps/index.md
      - courses/ps/note1.md
      - courses/ps/note2.md

  - Unsorted:
    - unsorted/index.md
    - Princeton Algorithms:
      - unsorted/princeton/index.md
      - unsorted/princeton/note1.md
      - unsorted/princeton/note2.md
    - Stanford CS144:
      - unsorted/cs144/index.md
      - unsorted/cs144/note1.md
    - 脑机接口导论:
      - unsorted/bciai/index.md
      - unsorted/bciai/ch3.md
      - unsorted/bciai/ch4.md
      - unsorted/bciai/ch5.md
    - 实用工具:
      - unsorted/tools/markdown.md
      - unsorted/tools/mac.md