mkdocs.yml

site_name: Emma's blog
site_url: https://emma-ssq.github.io/blog/
site_author: Emmassq
site_description: >-
  Emma's Blog, all about CS.

repo_name: blog
repo_url: https://github.com/Emma-ssq/blog/
copyright: Copyright &copy; 2022-present <a href="https://github.com/Emma-ssq" target="_blank">Emma-ssq</a>

theme:
  name: material
  language: zh
  static_templates:
    - 404.html
  favicon: images/winnie-pooh.png
  include_search_page: false #true搜索模板将在search/search.html上构建并可用，这个方法被readthedocs主题使用
  search_index_only: true #确定搜索插件是仅生成搜索索引还是生成完整的搜索解决方案

  # 字体
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github

  features:
    - header.autohide
    # - navigation.instant #即时加载
    # - navigation.expand #左侧边栏全展开，取消则折叠其他只展开当选
    # - navigation.sections #左侧目录两级
    # - toc.integrate #目录设置在左侧，注释掉使目录设置在右侧
    # - navigation.tabs #页面上层第一级目录，左侧第二级目录
    # - navigation.tabs.sticky
    - navigation.tracking #跟踪
    - navigation.top # back to top
    - navigation.indexes
    - search.highlight # 搜索高亮
    - search.share #搜索分享
    - search.suggest #搜索建议，省略回车
    # - content.code.annotate

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light blue
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: cyan
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to light mode

  # 在该文件夹下修改部分配置，覆盖父主题
  # custom_dir: overrides # 提供了github评论服务

markdown_extensions: #推荐配置Markdown基本语法及其扩展
  - pymdownx.highlight:
      anchor_linenums: true #代码块行号锚链接，默认false
      use_pygments: true #在构建期间使用Pygments或在浏览器中使用 JavaScript 语法高亮器进行高亮显示，默认true
      auto_title: true #自动为所有代码块添加标题，显示正在使用的语言的名称，默认false
      linenums: true #向所有代码块添加行号，默认false
      linenums_style: pymdownx-inline #三种添加行号的方法，建议table或pymdownx-inline。默认table
  - abbr #缩写或名词
  - pymdownx.snippets #片段，将任意文件或部分内容嵌入到文档中
  - admonition #警告或标注
  - pymdownx.details #细节折叠
  - pymdownx.superfences #超级围栏
  - attr_list #属性列表（按钮-颜色图标）
  - def_list #定义列表
  - footnotes #行内脚注
  - md_in_html #HTML 中的 Markdown
  - toc: #目录
      toc_depth: 3 #目录深度，默认6，0则隐藏
  #      title: On this page  #默认值，自动获取
  #      permalink: true   #每个标题的末尾添加段落符号锚链接，默认false
  #      permalink: ⚓︎  #每个标题的末尾添加自定义符号锚链接
  #      permalink_title: Anchor link to this section for reference #在悬停时显示并由屏幕阅读器阅读的锚链接的标题
  - tables #表格（未推荐）
  - pymdownx.arithmatex: #数学公式
      generic: true
  - pymdownx.betterem: #粗体斜体
      smart_enable: all
  - pymdownx.caret #插入角标符号(`^`)
  - pymdownx.mark #双等号(`==`)
  - pymdownx.tilde #波浪号(`~`)
  #评论家(突出显示建议更改)，未推荐
  - pymdownx.critic
  #      mode: reject #应如何解析标记，默认view查看更改，accept是接受更改，reject是拒绝更改
  - pymdownx.keys #键盘键和组合
  # 表情符号
  - pymdownx.emoji
  - pymdownx.highlight #代码高亮，对代码块（SuperFences）和行内代码块（InlineHilite）的语法突出显示
  - pymdownx.inlinehilite #行内高亮
  - pymdownx.smartsymbols #智能符号
  - pymdownx.tabbed: #内容选项卡
      alternate_style: true #启用内容选项卡替代样式，必须开启
  - pymdownx.tasklist: #任务列表
      custom_checkbox: true #切换复选框的呈现样式，将原生复选框样式替换为漂亮的图标
  #      clickable_checkbox: true  #切换复选框是否可点击，默认false，不建议开

extra_javascript:
  # 数学符号在网页上显示
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  social: # 设置页脚
    - icon: fontawesome/brands/github #github
      link: https://github.com/Emma-ssq/blog/
    - icon: fontawesome/solid/paper-plane #电子邮件
      link: sunshuqing@mail.ustc.edu.cn

  analytics: # 数据分析
    provider: google
    property: G-KJB4RXSKZG

# 插件
plugins:
  # 添加搜索栏
  - search:
      lang: ja
  # 关联github最后更新时间
  - git-revision-date-localized:
  # 压缩html，css，js
  - minify:
      minify_html: true

# 左侧导航
nav:
  - 前言: "index.md"
  - 代码规范: "代码规范/代码规范.md"
  - 实用工具:
      - 科学上网: "tools/科学上网.md"
      - 调试: "tools/Debug.md"
      - Vim: "tools/vim.md"
      - Git: "tools/Git.md"
      - Make: "tools/Make.md"
      - GitHub: "tools/GitHub.md"
      - Typora: "tools/Typora.md"
      - VSCode: "tools/VSCode.md"
      - GNU Make: "tools/GNU Make.md"
      - Docker: "tools/Docker.md"
      - mkdocs: "tools/mkdocs.md"
      - Docsify: "tools/Docsify.md"
      - 其他好用软件: "tools/其他好用软件.md"
  - 终端:
      - 终端与终端命令: "命令/终端命令.md"
      - python包管理工具pip: "命令/pip.md"
  - 编程软件操作及命令:
      - anaconda: "命令/anaconda.md"
  - 小白入门:
      - "Crash Course Computer Science": "小白入门/Crash Course Computer Science.md"
      - "MIT-Missing-Semester": "小白入门/MIT-Missing-Semester.md"
  - 编程语言:
      - "python: UCB CS61A": "coding language/UCB CS61A.md"
      - "python: 小甲鱼": "coding language/Python fish.md"
  - debug博客:
      - "TODO": "debug博客/template.md"
      - "本地打开远程": "debug博客/本地打开远程.md"
      - "ubuntu新建用户": "debug博客/ubuntu新建用户.md"
  - ToAchieve: "ToAchieve.md"