mkdocs.yml 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. #[Info]
  2. site_name: Mkdocs-G.R.D #your site name 显示在左上角
  3. site_url: https://grd.net.cn
  4. site_author: G.R.D Show Doc # your name
  5. #[UI]
  6. theme:
  7. name: material
  8. custom_dir: docs/overrides #覆写路径
  9. # font: #谷歌字体,自行搜索
  10. # text: Bitter #文本字体
  11. # code: Roboto Mono #代码字体
  12. logo: assets/favicon_GRD.png #左上角logo,可插入图片链接
  13. favicon: assets/favicon.ico # 网页icon
  14. #favicon: img/apple-line.png # 网页icon
  15. palette:
  16. #明暗按钮
  17. - media: "(prefers-color-scheme: light)"
  18. scheme: default # 日间模式
  19. primary: blue grey # 上方的
  20. accent: indigo # 链接等可交互元件的高亮色
  21. # teal
  22. toggle:
  23. icon: material/weather-night # 图标
  24. name: 切换至夜间模式 # 鼠标悬浮提示
  25. - media: "(prefers-color-scheme: dark)"
  26. scheme: slate # 夜间模式
  27. primary: black
  28. accent: indigo
  29. # teal
  30. toggle:
  31. icon: material/weather-sunny
  32. name: 切换至日间模式
  33. features:
  34. - announce.dismiss #呈现可标记为由用户读取的临时公告,可以包含一个用于取消当前公告的按钮
  35. # - navigation.instant
  36. #- header.autohide #自动隐藏
  37. - navigation.tracking #地址栏中的 URL 将自动更新为在目录中突出显示的活动锚点
  38. - navigation.tabs #顶级部分将呈现在上面视口标题下方的菜单层中,但在移动设备上保持原样
  39. # - navigation.tabs.sticky #启用粘性选项卡后,导航选项卡将锁定在标题下方,并在向下滚动时始终保持可见
  40. - navigation.sections #启用部分后,顶级部分在边栏中呈现为1220px以上视口的组,但在移动设备上保持原样
  41. - navigation.top # 返回顶部的按钮 在上滑时出现
  42. - navigation.footer #页脚将呈现在边栏中,但在移动设备上保持原样
  43. - search.suggest # 搜索输入一些字母时推荐补全整个单词
  44. - search.highlight # 搜索出的文章关键词加入高亮
  45. - search.share #搜索分享按钮
  46. - navigation.expand # 打开Tab时左侧目录全部展开
  47. - navigation.indexes #启用节索引页后,可以将文档直接附加到节
  48. - content.tabs.link
  49. - content.tooltips
  50. - content.code.copy #代码复制
  51. #- content.action.edit #编辑本页git
  52. #- content.action.view # 查看本页源代码
  53. - content.code.annotate
  54. language: zh # 一些提示性的文字会变成中文
  55. # ----------修改git图标和链接
  56. icon:
  57. #repo: fontawesome/brands/apple #git右上角图标github
  58. #edit_uri: edit/main/docs # git编辑按钮跳转的链接
  59. #repo_url: https://github.com/grd291/mindoc # git右上角点击跳转的链接
  60. #repo_name: Mkdocs-G.R.D # git右上角的名字
  61. # [Navigtion]
  62. nav:
  63. # - 主页: index.md
  64. - MKdocs中文教程:
  65. - MKdocs教程:
  66. - 利用mkdocs部署静态网页至GitHub pages: blog/Mkdocs/mkdocs1.md
  67. - Mkdocs部署静态网页至GitHub pages配置说明(mkdocs.yml): blog/Mkdocs/mkdocs2.md
  68. - 解决 mkdocs部署 Github Pages 自定义域名失效的问题: blog/Mkdocs/mkdocs3.md
  69. - 添加Mkdocs博客: blog/Mkdocs/mkdocsblog.md
  70. - Mkdocs美化:
  71. - 添加评论系统(giscus为例): blog/websitebeauty/mkcomments.md
  72. - 添加在线聊天: blog/websitebeauty/webtalknow.md
  73. - 添加友链: blog/websitebeauty/linktech.md
  74. - 添加顶部公告栏: blog/websitebeauty/header.md
  75. - 修改网站字体: blog/websitebeauty/mkdocsfont.md
  76. - JS实现鼠标样式: blog/websitebeauty/shubiao.md
  77. - 背景特效: blog/websitebeauty/backgroud.md
  78. - 添加404页面: blog/websitebeauty/404.md
  79. - 为MKdocs添加文章修订时间戳: blog/websitebeauty/time.md
  80. - 建设MKdocs技能指北:
  81. - Markdown:
  82. - Markdown指南: develop/Markdown/markdown.md
  83. - MWeb Pro: develop/Markdown/MWeb.md
  84. - Git 实用技巧: develop/git.md
  85. - 利用Lighthouse测试网站性能: develop/lighthouse.md
  86. - 如何将 github pages 迁移到 vercel 上托管: develop/vercel.md
  87. - 设计美学:
  88. - 唐·诺曼—情感设计的三个层次: develop/designbeauty/db1.md
  89. - 我对设计的一些观点: develop/designbeauty/my-to-desihn.md
  90. - 标签: tag.md
  91. - 留言板: liuyanban.md
  92. - Blogger:
  93. - index: blog/index.md
  94. - 友链:
  95. - 友链: about/link.md
  96. - 关于:
  97. - 作者个人简介: about/geren.md
  98. - 功能测试: about/test.md
  99. copyright: <p>Copyright &copy; 2022~ <script>document.write(new Date().getFullYear());</script> <a href="https://grd.net.cn" target="_blank">G.R.D</a> All Rights Reserved.</p> # 左下角的版权声明
  100. extra:
  101. generator: false # 去掉Made with Material for MkDocs
  102. social:
  103. - icon: fontawesome/brands/x-twitter #联系方式图标 : https://fontawesome.com/ 去这里找图标
  104. link: https://twitter.com/wcowin_
  105. - icon: fontawesome/brands/github
  106. link: https://github.com/Wcowin
  107. - icon: fontawesome/regular/envelope #联系方式图标
  108. link: mailto:<wangkewen821@gmail.com> #邮件联系方式
  109. - icon: fontawesome/brands/bilibili
  110. link: https://space.bilibili.com/1407028951?spm_id_from=333.1007.0.0
  111. - icon: fontawesome/brands/weixin
  112. link: https://space.bilibili.com/1407028951?spm_id_from=333.1007.0.0
  113. analytics:
  114. provider: google #谷歌分析
  115. property:
  116. # 网页底部反馈
  117. feedback:
  118. title: 此页面有帮助吗?
  119. ratings:
  120. - icon: material/thumb-up-outline #图标可自定义
  121. name: 此页面很有帮助
  122. data: 1
  123. note: >-
  124. 谢谢你的反馈!
  125. - icon: material/thumb-down-outline
  126. name: 此页面可以改进
  127. data: 0
  128. note: >-
  129. 感谢您的反馈!帮助我们通过以下方式改进此页面
  130. using our <a href="https://marketingplatform.google.com/about/analytics/" target="_blank" rel="noopener">feedback form</a>.
  131. # cookies设置(可选)
  132. # consent:
  133. # title: Cookie consent
  134. # description: >-
  135. # 我们也使用cookies来识别您的重复访问和偏好来衡量我们文档的有效性以及用户是否找到他们要找的东西。
  136. # 如果你同意,你可以帮助我们让我们的网站更好
  137. plugins:
  138. - search #搜索配置
  139. #- git-revision-date-localized:
  140. #type: iso_date
  141. #enable_creation_date: false
  142. #exclude:
  143. #- index.md
  144. - blog: #博客配置
  145. post_date_format: full #时间
  146. draft: true
  147. draft_if_future_date: true #自动将具有未来日期的帖子标记为草稿
  148. post_readtime: true
  149. post_readtime_words_per_minute: 265 #计算帖子的阅读时间时读者每分钟预计阅读的字数
  150. post_url_format: "{date}/{slug}"
  151. # categories_slugify: !!python/object/apply:pymdownx.slugs.slugify
  152. # kwds:
  153. # case: lower
  154. pagination_url_format: "page/{page}"
  155. authors_file: "{blog}/.authors.yml" #作者信息
  156. - tags:
  157. tags_file: tag.md #分类标签
  158. markdown_extensions: #详见https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/ 和 https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
  159. - abbr
  160. - attr_list
  161. - admonition
  162. - def_list
  163. - footnotes
  164. - md_in_html
  165. # - meta # 支持Markdown文件上方自定义标题标签等
  166. - pymdownx.caret
  167. - pymdownx.betterem
  168. - pymdownx.critic
  169. - pymdownx.details
  170. - pymdownx.inlinehilite
  171. - pymdownx.keys
  172. - pymdownx.mark
  173. - pymdownx.snippets
  174. - pymdownx.smartsymbols
  175. - pymdownx.tilde
  176. - pymdownx.superfences:
  177. custom_fences:
  178. - name: mermaid
  179. class: mermaid
  180. format: !!python/name:pymdownx.superfences.fence_code_format # 代码块高亮插件
  181. - pymdownx.arithmatex: # latex支持
  182. generic: true
  183. - toc:
  184. permalink: true # 固定标题位置为当前位置
  185. - pymdownx.highlight: # 代码块高亮
  186. anchor_linenums: true
  187. linenums: true # 显示行号
  188. # auto_title: true # 显示编程语言名称
  189. - pymdownx.emoji:
  190. emoji_index: !!python/name:material.extensions.emoji.twemoji
  191. emoji_generator: !!python/name:material.extensions.emoji.to_svg
  192. - pymdownx.tabbed:
  193. alternate_style: true
  194. - pymdownx.tasklist:
  195. custom_checkbox: true
  196. # - markdown.extensions.toc:
  197. # slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
  198. # permalink: "\ue157"
  199. extra_javascript:
  200. - javascripts/extra.js #自定义javascript
  201. - javascripts/mathjax.js #Latex支持
  202. - https://polyfill.io/v3/polyfill.min.js?features=es6 #Latex支持
  203. - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js #Latex支持
  204. - ckplayer/js/ckplayer.js #播放器配置
  205. - https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.min.js #gitalk支持
  206. - https://cdn.jsdelivr.net/npm/mermaid@10.0.2/dist/add-html-label-6e56ed67.min.js #忘了
  207. extra_css:
  208. - stylesheets/extra.css # 自定义CSS
  209. - stylesheets/link.css #友链配置
  210. # - stylesheets/video.css #播放器可选配置
  211. - https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.css #gitalk支持
  212. - ckplayer/css/ckplayer.css #播放器配置
  213. - https://cdn.staticfile.org/font-awesome/4.7.0/css/font-awesome.css # font-awesome表情支持
  214. # - https://cdnjs.cloudflare.com/ajax/libs/social-share.js/1.0.16/css/share.min.css #分享支持
  215. - https://cdn.jsdelivr.net/npm/lxgw-wenkai-webfont@1.1.0/style.css #字体
  216. - https://cdn.jsdelivr.net/npm/lxgw-wenkai-lite-webfont@1.1.0/style.css #字体
  217. - https://cdn.jsdelivr.net/npm/lxgw-wenkai-tc-webfont@1.0.0/style.css #字体
  218. # - https://cdn.jsdelivr.net/npm/lxgw-wenkai-screen-webfont@1.1.0/style.css #字体