Mkdocs教程
python 虚拟环境使用
mkdocs安装
mkdocs命令
mkdocs配置文件
mkdocs内嵌Open WebUI
本文档使用 MrDoc 发布
-
+
首页
mkdocs配置文件
### 配置文件1 ```yaml site_name: Material for MkDocs site_url: https://squidfunk.github.io/mkdocs-material/ site_author: Martin Donath site_description: >- Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, in 60+ languages, for all devices # Repository #repo_name: squidfunk/mkdocs-material #repo_url: https://github.com/squidfunk/mkdocs-material # Copyright copyright: Copyright © 2016 - 2024 Martin Donath # Configuration theme: name: material language: zh features: - announce.dismiss - content.action.edit - content.action.view - content.code.annotate - content.code.copy # - content.code.select # - content.footnote.tooltips # - content.tabs.link - content.tooltips # - header.autohide # - navigation.expand - navigation.footer - navigation.indexes # - navigation.instant # - navigation.instant.prefetch # - navigation.instant.progress # - navigation.prune - navigation.sections - navigation.tabs # - navigation.tabs.sticky - navigation.top - navigation.tracking - search.highlight - search.share - search.suggest - toc.follow # - toc.integrate palette: - media: "(prefers-color-scheme)" toggle: icon: material/link name: Switch to light mode - media: "(prefers-color-scheme: light)" scheme: default primary: indigo accent: indigo toggle: icon: material/toggle-switch name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: black accent: indigo toggle: icon: material/toggle-switch-off name: Switch to system preference font: text: Roboto code: Roboto Mono # favicon: assets/favicon.png # icon: logo: logo # Additional configuration extra: status: new: Recently added deprecated: Deprecated analytics: provider: google property: !ENV GOOGLE_ANALYTICS_KEY social: - icon: fontawesome/brands/github link: https://github.com/squidfunk - icon: fontawesome/brands/docker link: https://hub.docker.com/r/squidfunk/mkdocs-material/ - icon: fontawesome/brands/python link: https://pypi.org/project/mkdocs-material/ - icon: fontawesome/brands/mastodon link: https://fosstodon.org/@squidfunk - icon: fontawesome/brands/x-twitter link: https://x.com/squidfunk # Extensions markdown_extensions: - abbr - admonition - attr_list - def_list - footnotes - md_in_html - toc: permalink: true - pymdownx.arithmatex: generic: true - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.details - pymdownx.emoji: emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_index: !!python/name:material.extensions.emoji.twemoji - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink: normalize_issue_symbols: true repo_url_shorthand: true user: squidfunk repo: mkdocs-material - pymdownx.mark - pymdownx.smartsymbols - pymdownx.snippets: auto_append: - includes/mkdocs.md - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true combine_header_slug: true slugify: !!python/object/apply:pymdownx.slugs.slugify kwds: case: lower - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde plugins: - search: lang: - en - ja separator: '[\s\-\.]+' nav: - Home: index.md - About: about.md - Main: - Page1: Page1/Page1.md - Page2: Page1/Page2.md ``` ### 配置文件2 ```bash site_name: 学习小站 #site_url: https://squidfunk.github.io/mkdocs-material/ site_author: Jun site_description: >- Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, in 60+ languages, for all devices # Repository #repo_name: squidfunk/mkdocs-material #repo_url: https://github.com/squidfunk/mkdocs-material # Copyright copyright: Copyright © 2016 - 2024 Jun # Configuration theme: name: material language: zh features: - announce.dismiss - content.action.edit - content.action.view - content.code.annotate - content.code.copy # - content.code.select # - content.footnote.tooltips # - content.tabs.link - content.tooltips # - header.autohide # - navigation.expand - navigation.footer - navigation.indexes # - navigation.instant # - navigation.instant.prefetch # - navigation.instant.progress # - navigation.prune - navigation.sections - navigation.tabs # - navigation.tabs.sticky - navigation.top - navigation.tracking - search.highlight - search.share - search.suggest - toc.follow # - toc.integrate palette: - media: "(prefers-color-scheme)" toggle: icon: material/link name: Switch to light mode - media: "(prefers-color-scheme: light)" scheme: default primary: indigo accent: indigo toggle: icon: material/toggle-switch name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate primary: black accent: indigo toggle: icon: material/toggle-switch-off name: Switch to system preference font: text: Roboto code: Roboto Mono # favicon: assets/favicon.png # icon: logo: logo # Additional configuration extra: status: new: Recently added deprecated: Deprecated analytics: provider: google property: !ENV GOOGLE_ANALYTICS_KEY social: - icon: fontawesome/brands/github link: https://github.com/squidfunk - icon: fontawesome/brands/docker link: https://hub.docker.com/r/squidfunk/mkdocs-material/ - icon: fontawesome/brands/python link: https://pypi.org/project/mkdocs-material/ - icon: fontawesome/brands/mastodon link: https://fosstodon.org/@squidfunk - icon: fontawesome/brands/x-twitter link: https://x.com/squidfunk - icon: fontawesome/solid/envelope link: mailto:youremail@example.com extra: generator: false # Extensions markdown_extensions: - abbr - admonition - attr_list - def_list - footnotes - md_in_html - toc: permalink: true - pymdownx.arithmatex: generic: true - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.details - pymdownx.emoji: emoji_generator: !!python/name:material.extensions.emoji.to_svg emoji_index: !!python/name:material.extensions.emoji.twemoji - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink: normalize_issue_symbols: true repo_url_shorthand: true user: squidfunk repo: mkdocs-material - pymdownx.mark - pymdownx.smartsymbols - pymdownx.snippets: auto_append: - includes/mkdocs.md - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true combine_header_slug: true slugify: !!python/object/apply:pymdownx.slugs.slugify kwds: case: lower - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde plugins: - search: lang: - en - ja separator: '[\s\-\.]+' nav: - 主页: index.md - 病原生物与免疫学: - 绪论: Page1/Page1.md - 细菌概述: Page1/Page2.md - 关于: about.md ```
koalalove
2024年12月5日 13:53
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码