# 项目信息 site_name: 这是我的第一个MKdocs文档 # 文档站点的名称 site_url: https://u.ltwit.com # 文档站点的 URL # 主题设置 material\readthedocs\mkdocs theme: # 使用的主题,可以是内置主题或自定义主题 name: material # 主题名称 language: zh # 语言 # logo: logo.png # book的logo(文章标题的logo) # logo: # book的logo(文章标题的logo) homepage: https://u.ltwit.com favicon: logo.png # ico图标(网站图标) includes: - fontawesome features: - search.suggest # 启用建议搜索 - search.highlight # 突出显示搜索到的内容 - search.share # 搜索共享 - header.autohide # 自动隐藏导航栏 - navigation.tabs # 独立上面导航栏 - navigation.footer # 上一篇、下一篇显示 #例如 "fab fa-facebook" 表示 Brands 中的 Facebook 图标,"fas fa-heart" 表示 Solid 中的心形图标 #https://fontawesome.com/search?o=r&m=free fontawesome/brands fontawesome/solid icon: previous: fontawesome/solid/caret-left next: fontawesome/solid/caret-right top: material/lightbulb # logo: logo.png # book的logo(文章标题的logo) logo: fontawesome/solid/award annotation: material/arrow-right-circle # (调色板)白天晚上切换 palette: # Palette toggle for automatic mode(自动) - media: "(prefers-color-scheme)" primary: teal accent: yellow toggle: icon: material/brightness-auto name: Switch to light mode # Palette toggle for light mode(白天) - media: "(prefers-color-scheme: light)" primary: teal accent: yellow scheme: default toggle: icon: material/brightness-7 name: Switch to dark mode # Palette toggle for dark mode(晚上) - media: "(prefers-color-scheme: dark)" primary: teal accent: yellow scheme: slate toggle: icon: material/brightness-4 name: Switch to system preference # 版权信息 copyright: Copyright © 2020 - 2024 G.R.D # 额外的自定义配置 extra: custom_key: custom_value # 可以添加任意的自定义配置项 generator: false # 去掉Made with Material for MkDocs social: # 社交连接 - icon: fontawesome/brands/weixin link: https://doc.grd.net.cn/ name: G.R.Doc - icon: fontawesome/brands/steam link: https://doc.grd.net.cn/ # 邮箱 - icon: fontawesome/solid/paper-plane link: mailto: # 插件 plugins: - search # 索索 - tags # 内置插件标签 # - offline # - privacy # 所使用的Markdown扩展————一般不需要改动 markdown_extensions: # -------------配置标签(告诫) - admonition - pymdownx.details - pymdownx.superfences # -------------配置标签 # -------------配置附注(tab) - attr_list - md_in_html # - pymdownx.superfences # -------------配置标签 - md_in_html - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.critic - pymdownx.details # 支持emoji表情 - pymdownx.emoji: emoji_index: !!python/name:pymdownx.emoji.twemoji emoji_generator: !!python/name:pymdownx.emoji.to_svg - pymdownx.inlinehilite - pymdownx.magiclink - pymdownx.mark - pymdownx.smartsymbols - pymdownx.superfences - pymdownx.tasklist: custom_checkbox: true - pymdownx.tabbed - pymdownx.tilde - admonition - mdx_math: enable_dollar_delimiter: True # 导航栏设置 nav: - 家: index.md # 导航栏的链接和显示文本,链接可以是相对路径或绝对 URL - 编辑: - 子菜单1: 2.md - 子菜单2: index.md - 子子菜单: - 1: 1.md - 2: https://u.ltwit.com - 配置: 3.md - 价格: about.md - 关于: 1.md - 提醒标签: 提醒标签.md - Reference(参考): - reference/index.md - Admonitions: reference/admonitions.md - Annotations: reference/annotations.md - Buttons: reference/buttons.md - Code blocks: reference/code-blocks.md - Content tabs: reference/content-tabs.md - Data tables: reference/data-tables.md - Diagrams: reference/diagrams.md - Footnotes: reference/footnotes.md - Formatting: reference/formatting.md - Grids: reference/grids.md - Icons, Emojis: reference/icons-emojis.md - Images: reference/images.md - Lists: reference/lists.md - Math: reference/math.md - Tooltips: reference/tooltips.md