mkdocs.yml

site_name: 清华大学飞跃手册
repo_url: https://github.com/THU-feiyue/THU-feiyue
edit_uri: edit/main/docs/
site_url: https://feiyue.online
site_author: THU Feiyue Team
copyright: 'Copyright © 2024 THU Feiyue Team'

nav:
  - 首页:
    - index.md
    - 关于: main/about.md
    - 友链: main/friendlink.md
    - 名词解释: main/appendix.md
    - Q & A: main/qa.md
  - 前言:
    - 为什么出国留学: preface/why.md
    - master or doctor?: preface/master_phd.md
    - 国家/地区选择: preface/location.md
    - 信息收集: preface/info.md
    - 中介 or DIY: preface/diy.md
    - 时间线: preface/timeline.md
  - 准备:
    - prepare/index.md
    - GPA & 标化考试: prepare/exam.md
    - 经历:
      - prepare/experience/index.md
      - 科研: prepare/experience/research.md
      - 实习: prepare/experience/intern.md
      - 交换: prepare/experience/exchange.md
    - 推荐信: prepare/rl.md
    - 选校定位: prepare/selection.md
    - 套磁: prepare/touch.md
    - 文书:
      - prepare/material/index.md
      - CV: prepare/material/cv.md
      - PS / SOP: prepare/material/sop.md
      - 成绩单、学位证: prepare/material/transcript.md
      - Research Proposal: prepare/material/rp.md
      - Diversity Statement: prepare/material/diversity.md
      - Writing Sample: prepare/material/writingsample.md
      - 个人网站/作品集: prepare/material/homepage.md
    - 网申: prepare/onlinesystem.md
    - 面试: prepare/interview.md
    - 其它帮助:
      - 学信网认证: prepare/help/chsi.md
      - TOEFL/GRE 家考注意事项: prepare/help/toefl-home.md
      - 申请信息表格整理: prepare/help/summarytable.md
      - APS: prepare/help/aps.md
  - 录取及之后:
    - 录取及之后: afterad/index.md
    - Funding: afterad/funding.md
    - 等待 Offer: afterad/waiting.md
    - 比较决定: afterad/compare.md
    - 签证: afterad/visa.md
    - 前往: afterad/travel.md
    - 租房: afterad/rent.md
  - 案例: cases.md
  - 文章阅读: reading/index.md
  - 联系与支持:
    - 联系与支持: contact/support.md
    - 功德墙: contact/contributor.md

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.footer
    - navigation.top
    - toc.follow
    - announce.dismiss
  font:
    text: 'Fira Sans'
    code: 'Fira Mono'
  # Necessary for search to work properly
  include_search_page: false
  search_index_only: false

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      linenums: true
      linenums_style: pymdownx-inline
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

extra_javascript:
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search:
      lang:
        - en
        - ja
      separator: '[\s\u200b\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - git-revision-date-localized
  - add-number:
      strict_mode: False
      order: 2
  - git-authors:
      show_contribution: true
  - redirects:
      redirect_maps:
        cases.md: https://database.feiyue.online