mkdocs.yml

# info
site_name: PhilFan's Notebook
site_author: PhilFan
site_description: PhilFan的笔记本
site_url: "https://www.philfan.cn"

# repository information
repo_name: 'Phil-Fan/Notes'
repo_url: 'https://github.com/Phil-Fan/Phil-Fan.github.io'

# copyright
copyright: Copyright <span style="font-family:Arial;">&copy;</span> 2023-2024 <a href="https://github.com/Phil-Fan" target="_blank">PhilFan</a>

# configuration
theme:
  name: material
  logo: logo.ico
  favicon: logo.ico
  custom_dir: overrides
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
     
  features:
    # 导航功能
    - navigation.tracking  # 跟踪用户在站点中的导航路径
    - navigation.tabs  # 顶部显示导航标签
    - navigation.path  # 显示当前页面的路径
    - navigation.indexes  # 在导航中显示索引页
    - navigation.top  # 提供回到页面顶部的按钮
    - navigation.footer  # 在页面底部显示导航链接
    - navigation.instant  # 启用即时导航，提高页面加载速度
    
    # 搜索功能
    - search.highlight  # 高亮显示搜索结果
    - search.share  # 允许分享搜索结果
    - search.suggest  # 提供搜索建议
    
    # 内容展示功能
    - toc.follow  # 目录（TOC）跟随滚动，高亮当前阅读部分
    - content.code.annotate  # 为代码块添加注释
    - content.code.copy  # 允许复制代码块
    - content.tabs.link  # 支持内容中的标签链接


  language: 'zh'
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to light mode

  font:
    text: Noto Serif SC # Roboto
    code: JetBrains Mono

markdown_extensions:
  # 基础Markdown扩展
  - abbr  # 支持缩写
  - admonition  # 支持警告框
  - attr_list  # 允许为Markdown元素添加HTML属性
  - def_list  # 支持定义列表
  - footnotes  # 支持脚注
  - md_in_html  # 允许在HTML块中使用Markdown
  - tables  # 支持表格

  # 目录生成
  - toc:
      permalink: true  # 为每个标题生成永久链接
      toc_depth: 3  # 目录深度为3级
      permalink_title: "anchor link to this section for reference"  # 永久链接标题
  - markdown.extensions.smarty:
      smart_quotes: false  # 关闭智能引号

  # 公式渲染
  - pymdownx.arithmatex:
      generic: true  # 支持内联和块级数学公式，使用MathJax渲染
      # block_tag: 'pre'  # 使用<pre>标签包裹块级公式

  # 代码高亮与代码相关功能
  - pymdownx.highlight  # 提供代码块的语法高亮

  - pymdownx.superfences:
      preserve_tabs: true  # 保留制表符
      custom_fences:
        - name: diagram
          class: diagram
          format: !!python/name:pymdownx.superfences.fence_code_format  # Mermaid图表
        # - name: math
        #   class: arithmatex
        #   format: !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format  # 数学公式

  # 扩展Markdown语法
  - pymdownx.caret  # 支持插入符号（^）表示上标
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji  # 使用Twemoji索引
      emoji_generator: !!python/name:material.extensions.emoji.to_svg  # 使用SVG生成Emoji
  - pymdownx.magiclink:
      repo_url_shorthand: true  # 使用简写形式的仓库链接
      repo_url_shortener: true  # 缩短仓库链接
      social_url_shorthand: true  # 社交链接简写
      social_url_shortener: true  # 社交链接缩短
  - pymdownx.mark  # 提供文本高亮功能
  - pymdownx.smartsymbols  # 自动将特定文本符号转换为对应的智能符号
  - pymdownx.tasklist:
      custom_checkbox: true  # 允许创建自定义风格的任务列表
  - pymdownx.tilde  # 使用波浪线（~）表示删除线

  # 文档布局与样式
  - pymdownx.details  # 允许添加可展开的详细信息块
  - pymdownx.tabbed:
      alternate_style: true  # 使用备用样式的标签式布局
  - pymdownx.keys  # 支持按键表示
  - pymdownx.escapeall:
      hardbreak: True  # 硬换行
      nbsp: True  # 不断行空格

  # 其他功能
  - pymdownx.progressbar  # 支持进度条
  - pymdownx.striphtml  # 去除HTML标签
  - pymdownx.saneheaders  # 优化标题解析，避免冲突

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Phil-Fan
      name: PhilFan's Profile

  analytics:
    provider: google
    property: G-2QNP7S5RJ8 # 请勿复制这一行

    feedback:
      title: Was this note helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            感谢支持~
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >- 
            感谢指出，有任何问题可以直接评论~

extra_css:
  # - style/css/extra.css
  # source: MinJoker.github.io/docs/stylesheets
  - style/css/custom.css
  - style/css/counter.css
  - style/css/toc.css
  - style/css/flink.css
  # - https://unpkg.com/katex@0/dist/katex.min.css
  # source: https://tonycrane.cc/
  - 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

extra_javascript:
  - style/js/toc.js
  # - style/js/katex.js
  - style/js/mathjax.js
  # - https://unpkg.com/katex@0/dist/katex.min.js
  # - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
   # 支持数学公式，ref : https://squidfunk.github.io/mkdocs-material/reference/mathjax
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js


# navigation: 注意左右下划线的写法
nav:
- Home: 
  - index.md
  - "友链": reference.md
    
- Class:
  - Class/signal.md
  - Class/SocialSciences.md
  - Class/马原.md
  - Class/毛概.md
  
  - Oral:
    - Class/English/Oral-Practice.md
    - Class/English/Oral-Tips.md
    - Class/English/TOFEL-speaking-training.md
    - Class/English/TOFEL-speaking.md
    - Class/English/VocabularyForSpeaking.md

  - "ITP课程" :
      - Class/ITP/ITP-Team-Communication-and-Leadership.md
      - Class/ITP/ITP-Management.md
      - Class/ITP/ITP-创业营销.md
      - Class/ITP/ITP-商业模式.md
      - Class/ITP/ITP-市场分析与调研.md   
      
  - Finance:
    - Class/Fin/invest.md
    - Class/Fin/consulting.md
  
  - "行业研习":
    - Class/Fin/industry-analyze.md
    - Class/Fin/industry-internet.md
    - Class/Fin/industry-car.md
    - Class/Fin/industry-finance.md
    - Class/Fin/industry-game.md
    - Class/Fin/industry-hotel.md
    - Class/Fin/industry-welfare.md

  - Books:
    - Class/Books/The Innovator`s Dilemma.md 
    - Class/Books/Marxist principles.md
    - Class/Philosophy.md
    - Class/Philosophy-by-topic.md
     
  
- Robotics:
  - "嵌入式":
    - Robotics/嵌入式/Analog.md
    - Robotics/嵌入式/Digital.md
    - Robotics/嵌入式/EmbeddedSystem-intro.md
    - Robotics/嵌入式/EmbeddedSystem-8051.md
    - Robotics/嵌入式/EmbeddedSystem-8051-experiment.md
    - Robotics/嵌入式/EmbeddedSystem-digitalcircuit.md
    - Robotics/嵌入式/EmbeddedSystem-stm32.md
    - Robotics/嵌入式/RaspberryPi.md
    - Robotics/嵌入式/FPGA.md

  - "Control Theory":
    - Robotics/Control/Control-01-自动控制原理.md
    - Robotics/Control/Control-02-现代控制理论.md
    - Robotics/Control/Control-03-nonlinear.md
    - Robotics/Control/Control-04-optimal.md
    - Robotics/Control/Control-10-经典控制方法.md
    - Robotics/Control/Control-11-智能控制方法.md
    - Robotics/Control/Control-12-电气控制.md

  - "机器人":
    - Robotics/Robo/Robo-00-intro.md
    - Robotics/Robo/Robo-00-model.md
    - Robotics/Robo/Robo-00-Introduction-to-Robotics.md 
    - Robotics/Robo/Robo-00-Introduction-to-Robotics-exam.md
    - Robotics/Robo/Robo-01-sensor&detection.md
    - Robotics/Robo/Robo-02-0-navigation.md
    - Robotics/Robo/Robo-02-1-localization.md
    - Robotics/Robo/Robo-02-2-mapping.md
    - Robotics/Robo/Robo-02-3-planning.md
    - Robotics/Robo/Robo-probabilistic_robot.md
    - Robotics/Robo/Robo-Drone.md      
    - Robotics/Robo/Robo-arm.md

  - "通信":
    - Robotics/communication/CC-NFC.md
    - Robotics/communication/CC-bluetooth.md
  
  - "实践记录":
    - Robotics/嵌入式/嘉立创.md
    - Robotics/嵌入式/焊接.md
    - Robotics/嵌入式/EmbeddedSystem-experiment.md
    - Robotics/Robo/Robo-Drone_experiment.md
    - Robotics/Robo/Robo-Drone-explore.md

  - "环境配置":
    - Robotics/Calculator.md
    - Robotics/Environment/System-Linux.md 
    - Robotics/Environment/System-ROS.md   
    - Robotics/Environment/System-linux-settings.md
    - Robotics/Environment/System-kali-settings.md
    - Robotics/Environment/System-python-settings.md
    - Robotics/Environment/System-server.md
    - Robotics/Environment/System-docker.md

- "CS":
  - Language:
    # - CS/Language/Assembly.md
    - CS/Language/C.md
    - CS/Language/C++.md
    - CS/Language/Python.md
    - "Python速查":
      - "Seaborn": https://seaborn.pydata.org/api.html
      - "Pandas": https://pandas.pydata.org/docs/reference/index.html
      - "Scipy": https://docs.scipy.org/doc/scipy/reference/index.html
  
  - FrontEnd:
    - CS/Frontend/HTML.md
    - CS/Frontend/CSS.md
    - CS/Frontend/JavaScript.md

  - BackEnd:
    - CS/Backend/SQL.md
    - CS/Backend/Nodejs.md
    - CS/Backend/PHP.md


  - "数学基础":
    - CS/AI/ML-00-math.md
    - CS/AI/logic.md
    - "概率论":
      - CS/Statistic/00-intro.md
      - Notebook page: CS/Statistic/01-probability.ipynb
      - Notebook page: CS/Statistic/02-Univariate_Random_Variable.ipynb
      - Notebook page: CS/Statistic/03-Multivariate_Random_Variable.ipynb
      - Notebook page: CS/Statistic/04-Numerical_Features.ipynb
      - Notebook page: CS/Statistic/05-Special_Functions.ipynb
      - Notebook page: CS/Statistic/06-Parameter_Estimation.ipynb
      - Notebook page: CS/Statistic/07-Hypothesis_Testing.ipynb
      - Notebook page: CS/Statistic/08-Goodness_of_Fit.ipynb
      - Notebook page: CS/Statistic/09-Regression.ipynb
      - Notebook page: CS/Statistic/10-Multiple_Regression_and_Analysis_of_Variance.ipynb
      - Notebook page: CS/Statistic/11-error.ipynb
      - CS/Statistic/11-anova.md
      - CS/Statistic/12-data_mining.md
      - CS/Statistic/big_data_security&privacy_protection.md
      - "作业":
        - Notebook page: Lab02-pro.ipynb
        - Notebook page: Lab03-st.ipynb
        - Notebook page: Lab04-numerical_features.ipynb
        - Notebook page: Lab05-SF.ipynb
        - Notebook page: Lab06-hypothesis.ipynb
        - Notebook page: Lab07-linear.ipynb
   
  - "DS | 数据结构":
    - CS/DS/DataStructure.md
    - CS/DS/DataStructure-Tree.md
    - CS/DS/DataStructure-Hash.md
    - CS/DS/DataStructure-Graph.md
    - CS/DS/DataStructure-Sorting.md

  - "CN | 计算机网络" :
    - CS/CN/ComputerNetwork-00-intro.md
    - CS/CN/ComputerNetwork-01-ApplicationLayer.md
    - CS/CN/ComputerNetwork-02-TransportLayer.md
    - CS/CN/ComputerNetwork-03-NetworkLayer.md
    - CS/CN/ComputerNetwork-04-LinkLayer.md
    - CS/CN/ComputerNetwork-05-PhysicalLayer.md
    - CS/CN/ComputerNetwork-06-experiment.md
    - CS/CN/ComputerNetwork-07-问题探究.md
    - CS/CN/ComputerNetwork-08-security.md
    - CS/CN/DingBot.md
    
  - "OR | 运筹学 ":
    - CS/OR/OR-exercise.md
    - CS/OR/OR.md
    - CS/OR/OR-nonlinear.md
    - CS/OR/OR-DP.md
    - CS/OR/OR-GameTheory.md
    - CS/OR/OR-GameTheoryModel.md
    - CS/OR/OR-QueuingTheory.md
    
  - "AI | 人工智能": 
    - "搜索 | Search": 
      - CS/AI/01-AI_history&intro.md
      - CS/AI/02-UninformedSearch.md     
      - CS/AI/03-InformedSearch.md       
      - CS/AI/04-OtherSearch.md

    - "ML | 机器学习": 
      - CS/AI/ML-01-intro.md
      - CS/AI/ML-02-LinearRegression.md
      - CS/AI/ML-03-DecisionTree.md
      - CS/AI/ML-04-SVM.md
      - CS/AI/ML-05-bayes.md
      - Notebook page:  CS/AI/ML-06-clustering.ipynb
      - CS/AI/ML-07-DimensionalityReduction.md
      - CS/AI/ML-08-EnsembleLearning.md
      - CS/AI/ML-09-else.md
      - CS/AI/ML-10-SemiSupervisedLearning.md
      - CS/AI/ML-11-ConceptLearning.md
      - CS/AI/ML-CSE.md
      - CS/AI/ML-15-interpretable_models.md


    - "DL | 深度学习":
      - CS/AI/DL-00-Lingo.md
      - Notebook page: CS/AI/DL-00-python_package.ipynb
      - CS/AI/DL-00-pytorch.md
      - CS/AI/DL-01-NN.md
      - CS/AI/DL-06-CNN.md
      - CS/AI/DL-08-RNN.md
      - CS/AI/DL-09-modernRNN.md
      - CS/AI/DL-11-optimation.md        
      - CS/AI/DL-12-setting.md
      - CS/AI/DL-application.md
      - CS/AI/DL-Homework.md
      - CS/AI/DL-problem.md

    - "RL | 强化学习":
      - CS/AI/RL-01.md

    - "SEC | 人工智能安全":
      - CS/AI/SEC-01-attack.md
      - CS/AI/SEC-02-whitebox.md
      - CS/AI/SEC-03-blackbox.md
      - CS/AI/SEC-04-GANS.md
      - CS/AI/SEC-thesis.md
      
         
  - "CV | 计算机视觉":
    - CS/CV/CV-00-1-intro.md
    - "图像处理":
        - CS/CV/CV-00-base.md
        - CS/CV/color.md
        - CS/CV/CV-00-2-camera.md
        - CS/CV/CV-00-3-format.md
    - "基本任务":
        - CS/CV/CV-01-classification.md
        - CS/CV/CV-02-Image-location.md
        - CS/CV/CV-03-face-Recognition.md
        - CS/CV/CV-03-Object-Recognition.md
        - CS/CV/CV-04-Segmentation.md
        - CS/CV/CV-10-3D.md
        - CS/CV/CV-11-motion_estimation.md
    - CS/CV/OpenCV.md
    - CS/CV/HumanPoseEstimation.md  

  - "CTF相关知识":
    - CS/SEC/CTF-intro.md
    - CS/SEC/CTF-web.md
    - CS/SEC/CTF-misc.md
    - CS/SEC/CTF-reverse.md
    - CS/SEC/CTF-pwn.md
    - CS/SEC/CTF-crypto.md
    - CS/SEC/CTF-CPS.md
    
  - "Web3":
    - CS/Web3/blockchain.md
    - CS/Web3/contract.md
    - CS/Web3/solidity.md
    - CS/Web3/lingo.md
  - "Dev":
    - CS/missing_knowledge.md
    - CS/Dev/rules.md
    - CS/Dev/tampermonkey.md


- Tools:
  - Tools/Git.md
  - Tools/gdb.md
      
  - "效率":
    - Tools/markdown.md
    - Tools/Mkdocs.md
    - Tools/JekyII.md
    - Tools/latex.md
    - "Latex公式速查": https://latex.emoryhuang.cn/posts/
    - Tools/vim.md
    
  - Tools/tableau.md
  - Tools/matlab.md
  - Tools/solidworks.md
  - Tools/sites.md
  
  - Tools/settings.md
  - Tools/settings-macos.md
  

- "生命因你而火热":
  - "🏫浙大": classes_in_zju.md
  - "💐插花": else/flower.md
  - "🍚豆知识": else/bean_knowledge.md
  # - else/interview.md

  - "🏃运动":
    - else/exercise-fit.md
    - else/exercise-swimming.md
    - else/exercise-tennis.md
    - else/dance.md

  - "🥢食为天":
    - else/eat.md
    - else/coffee.md

  - "🗺️出行":
    - else/Travel/C-Driving.md
    - else/Travel/C-journey.md
    - else/Travel/C-J-杭州.md
    - else/Travel/C-J-浙江.md
    - else/Travel/C-J-江西.md
    - else/Travel/C-J-四川.md
    - else/Travel/C-J-安徽.md
    - else/Travel/C-J-HK.md
    - else/Travel/C-J-Japan.md
    - else/Travel/C-J-MY.md
    - else/Travel/C-J-MY-KK.md
    - else/Travel/C-J-MY-KL.md

  - "🎶音乐":
    - else/music_theory.md
    - else/piano.md
    - else/piano_learning.md
    - else/piano_songs.md
    - else/music_classification.md

  - "🎨设计":
    - Tools/design.md
    - Tools/powerpoint.md
    - Tools/AdobePhotoshop.md
    - Tools/AdobeIllustrator.md
    
  - "📸摄影":
    - Tools/Photography-base.md
    - Tools/Photography-Landscape.md
    - Tools/Photography-Portrait.md

  - "🎮游戏":
    - else/fifa.md

  - "💡常识":
    - else/common_knowledge/social_security.md
    - else/common_knowledge/insurance_social_insurance.md
    - else/common_knowledge/insurance_commercial_insurance.md
    - else/common_knowledge/labour.md
    - else/common_knowledge/tax.md
    - else/common_knowledge/accident.md
    - else/common_knowledge/house.md
    - else/common_knowledge/rent.md
    




plugins:
  # meta
  - search:
      lang:
        - zh
        - en
        - ja
      separator: '[\s\u200b\-]'
  
  # https://github.com/TonyCrane/mkdocs-heti-plugin
  - heti:
      disable_serve: false
  
  # https://github.com/TonyCrane/mkdocs-statistics-plugin
  - statistics:
      words_per_minute: 256
      codelines_per_minute: 80
  
  # 这个插件用于压缩HTML输出，减少页面的加载时间和带宽消耗。
  # 重构环境的时候，这个插件貌似有一点点问题
  # - minify:
  #     minify_html: true

  # 显示文件的最后修改时间，基于git提交记录
    # 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
  
  - mkdocs-jupyter:
      execute: true
      kernel_name: python3
      theme: dark
      include_source: True
      custom_mathjax_url: "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS_CHTML-full,Safe"
  # todo: 修复数学公式问题

  - mkdocs-video:
      is_video: True
      video_muted: True
      video_controls: True
      css_style:
        width: "50%"