mkdocs.yml 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177
  1. # 项目信息
  2. site_name: 这是我的第一个MKdocs文档 # 文档站点的名称
  3. site_url: https://u.ltwit.com # 文档站点的 URL
  4. # 主题设置 material\readthedocs\mkdocs
  5. theme: # 使用的主题,可以是内置主题或自定义主题
  6. name: material # 主题名称
  7. language: zh # 语言
  8. # logo: logo.png # book的logo(文章标题的logo)
  9. # logo: # book的logo(文章标题的logo)
  10. homepage: https://u.ltwit.com
  11. favicon: logo.png # ico图标(网站图标)
  12. includes:
  13. - fontawesome
  14. features:
  15. - search.suggest # 启用建议搜索
  16. - search.highlight # 突出显示搜索到的内容
  17. - search.share # 搜索共享
  18. - header.autohide # 自动隐藏导航栏
  19. - navigation.tabs # 独立上面导航栏
  20. - navigation.footer # 上一篇、下一篇显示
  21. #例如 "fab fa-facebook" 表示 Brands 中的 Facebook 图标,"fas fa-heart" 表示 Solid 中的心形图标
  22. #https://fontawesome.com/search?o=r&m=free fontawesome/brands fontawesome/solid
  23. icon:
  24. previous: fontawesome/solid/caret-left
  25. next: fontawesome/solid/caret-right
  26. top: material/lightbulb
  27. # logo: logo.png # book的logo(文章标题的logo)
  28. logo: fontawesome/solid/award
  29. annotation: material/arrow-right-circle
  30. # (调色板)白天晚上切换
  31. palette:
  32. # Palette toggle for automatic mode(自动)
  33. - media: "(prefers-color-scheme)"
  34. primary: teal
  35. accent: yellow
  36. toggle:
  37. icon: material/brightness-auto
  38. name: Switch to light mode
  39. # Palette toggle for light mode(白天)
  40. - media: "(prefers-color-scheme: light)"
  41. primary: teal
  42. accent: yellow
  43. scheme: default
  44. toggle:
  45. icon: material/brightness-7
  46. name: Switch to dark mode
  47. # Palette toggle for dark mode(晚上)
  48. - media: "(prefers-color-scheme: dark)"
  49. primary: teal
  50. accent: yellow
  51. scheme: slate
  52. toggle:
  53. icon: material/brightness-4
  54. name: Switch to system preference
  55. # 版权信息
  56. copyright: Copyright © 2020 - 2024 G.R.D
  57. # 额外的自定义配置
  58. extra:
  59. custom_key: custom_value # 可以添加任意的自定义配置项
  60. generator: false # 去掉Made with Material for MkDocs
  61. social: # 社交连接
  62. - icon: fontawesome/brands/weixin
  63. link: https://doc.grd.net.cn/
  64. name: G.R.Doc
  65. - icon: fontawesome/brands/steam
  66. link: https://doc.grd.net.cn/
  67. # 邮箱
  68. - icon: fontawesome/solid/paper-plane
  69. link: mailto:<sever@ltwit.com>
  70. # 插件
  71. plugins:
  72. - search # 索索
  73. - tags # 内置插件标签
  74. # - offline
  75. # - privacy
  76. # 所使用的Markdown扩展————一般不需要改动
  77. markdown_extensions:
  78. # -------------配置标签(告诫)
  79. - admonition
  80. - pymdownx.details
  81. - pymdownx.superfences
  82. # -------------配置标签
  83. # -------------配置附注(tab)
  84. - attr_list
  85. - md_in_html
  86. # - pymdownx.superfences
  87. # -------------配置标签
  88. - md_in_html
  89. - pymdownx.betterem:
  90. smart_enable: all
  91. - pymdownx.caret
  92. - pymdownx.critic
  93. - pymdownx.details
  94. # 支持emoji表情
  95. - pymdownx.emoji:
  96. emoji_index: !!python/name:pymdownx.emoji.twemoji
  97. emoji_generator: !!python/name:pymdownx.emoji.to_svg
  98. - pymdownx.inlinehilite
  99. - pymdownx.magiclink
  100. - pymdownx.mark
  101. - pymdownx.smartsymbols
  102. - pymdownx.superfences
  103. - pymdownx.tasklist:
  104. custom_checkbox: true
  105. - pymdownx.tabbed
  106. - pymdownx.tilde
  107. - admonition
  108. - mdx_math:
  109. enable_dollar_delimiter: True
  110. # 导航栏设置
  111. nav:
  112. - 家: index.md # 导航栏的链接和显示文本,链接可以是相对路径或绝对 URL
  113. - 编辑:
  114. - 子菜单1: 2.md
  115. - 子菜单2: index.md
  116. - 子子菜单:
  117. - 1: 1.md
  118. - 2: https://u.ltwit.com
  119. - 配置: 3.md
  120. - 价格: about.md
  121. - 关于: 1.md
  122. - 提醒标签: 提醒标签.md
  123. - Reference(参考):
  124. - reference/index.md
  125. - Admonitions: reference/admonitions.md
  126. - Annotations: reference/annotations.md
  127. - Buttons: reference/buttons.md
  128. - Code blocks: reference/code-blocks.md
  129. - Content tabs: reference/content-tabs.md
  130. - Data tables: reference/data-tables.md
  131. - Diagrams: reference/diagrams.md
  132. - Footnotes: reference/footnotes.md
  133. - Formatting: reference/formatting.md
  134. - Grids: reference/grids.md
  135. - Icons, Emojis: reference/icons-emojis.md
  136. - Images: reference/images.md
  137. - Lists: reference/lists.md
  138. - Math: reference/math.md
  139. - Tooltips: reference/tooltips.md