mkdocs.yml 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. # 所有网页的统一标题
  2. # 标题建议统一格式,如:XXXXXX实验(2023春季) | 哈工大(深圳)
  3. site_name: GiteePage入门指南(202X秋/春/夏季) | 哈工大(深圳)
  4. # 版权信息————记得更新年份
  5. copyright: 'Copyright © 2019 - 2023 哈尔滨工业大学(深圳)'
  6. # 仓库名称(非必须)————可自定义
  7. repo_name: 'GiteePageDemoRepo'
  8. # 仓库URL(非必须)
  9. repo_url: 'https://gitee.com/hitsz-cslab/gitee-page-demo'
  10. # 所使用的Markdown扩展————一般不需要改动
  11. markdown_extensions:
  12. - pymdownx.betterem:
  13. smart_enable: all
  14. - pymdownx.caret
  15. - pymdownx.critic
  16. - pymdownx.details
  17. # 支持emoji表情
  18. - pymdownx.emoji:
  19. emoji_index: !!python/name:pymdownx.emoji.twemoji
  20. emoji_generator: !!python/name:pymdownx.emoji.to_svg
  21. - pymdownx.inlinehilite
  22. - pymdownx.magiclink
  23. - pymdownx.mark
  24. - pymdownx.smartsymbols
  25. - pymdownx.superfences
  26. - pymdownx.tasklist:
  27. custom_checkbox: true
  28. - pymdownx.tabbed
  29. - pymdownx.tilde
  30. - admonition
  31. - mdx_math:
  32. enable_dollar_delimiter: True
  33. extra_javascript:
  34. - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML
  35. # - mathjaxhelper.js
  36. # GiteePage主题————使用统一模板:material
  37. theme:
  38. language: 'zh'
  39. name: material
  40. custom_dir: overrides
  41. # favicon: favicon.png
  42. features:
  43. - navigation.tabs
  44. icon:
  45. # 网页标题左侧的图标————可更换成其他fontawesome图标,详见https://fontawesome.com/
  46. logo: fontawesome/brands/git-alt
  47. repo: fontawesome/brands/git-alt
  48. # favicon: favicon.png
  49. palette:
  50. - scheme: 'default' # 白天模式
  51. primary: 'blue' # 网页底色
  52. accent: 'red' # 交互元素颜色
  53. toggle:
  54. icon: material/weather-sunny
  55. name: 切换到夜晚模式
  56. - scheme: 'slate' # 夜晚模式
  57. primary: 'blue' # 网页底色
  58. accent: 'red' # 交互元素颜色
  59. toggle:
  60. icon: material/weather-night
  61. name: 切换到白天模式
  62. # 导航设置
  63. # (1)最多三级缩进,每一级缩进对应一个级别层次
  64. # (2)可使用中文或其他语言的字符,但文字与markdown文件之间的冒号必须是英文冒号
  65. nav:
  66. - 首页:
  67. - 实验须知: index.md
  68. - 作业提交说明: homewk.md
  69. - 实验1:XXX:
  70. - 实验概述: lab1/overview.md
  71. - 实验原理: lab1/theory.md
  72. - 实验步骤: lab1/step.md
  73. - 附加题: lab1/extra.md
  74. - 验收与提交: lab1/submit.md
  75. - 实验2:XXX:
  76. - 实验概述: lab2/overview.md
  77. - 实验原理: lab2/theory.md
  78. - 实验步骤: lab2/step.md
  79. - 附加题: lab2/extra.md
  80. - 验收与提交: lab2/submit.md
  81. - MkDocs使用说明: mkdocs_guide/mkdocs_guide.md