mirror of
https://github.com/Wcowin/Mkdocs-Wcowin.git
synced 2025-07-20 08:56:35 +00:00
306 lines
12 KiB
YAML
306 lines
12 KiB
YAML
#[Info]
|
||
site_name: Mkdocs中文教程 #your site name 显示在左上角
|
||
site_url: http://wcowin.work/Mkdocs-Wcowin
|
||
site_description: Content and ambitious, gentle yet firm.
|
||
site_author: 王科文(Wcowin) # your name
|
||
#[UI]
|
||
theme:
|
||
name: material
|
||
custom_dir: docs/overrides #覆写路径
|
||
# logo: assets/favicon.png #左上角logo，可插入图片链接
|
||
|
||
favicon: https://s2.loli.net/2025/02/12/aE5ovtzAlNTd9Uh.png # 网页icon
|
||
|
||
palette:
|
||
- media: "(prefers-color-scheme)"
|
||
toggle:
|
||
icon: material/link
|
||
name: 关闭自动模式
|
||
- media: "(prefers-color-scheme: light)"
|
||
scheme: default # 日间模式
|
||
primary: blue # 上方的
|
||
accent: indigo # 链接等可交互元件的高亮色
|
||
toggle:
|
||
icon: material/toggle-switch # 图标
|
||
name: 切换至夜间模式 # 鼠标悬浮提示
|
||
- media: "(prefers-color-scheme: dark)"
|
||
scheme: slate # 夜间模式
|
||
primary: black
|
||
accent: indigo
|
||
toggle:
|
||
icon: material/toggle-switch-off-outline
|
||
name: 切换至日间模式
|
||
|
||
features:
|
||
- announce.dismiss #呈现可标记为由用户读取的临时公告，可以包含一个用于取消当前公告的按钮
|
||
- navigation.tracking #地址栏中的 URL 将自动更新为在目录中突出显示的活动锚点
|
||
- navigation.tabs #顶级部分将呈现在上面视口标题下方的菜单层中，但在移动设备上保持原样
|
||
- navigation.sections #启用部分后，顶级部分在边栏中呈现为1220px以上视口的组，但在移动设备上保持原样
|
||
- navigation.top # 返回顶部的按钮 在上滑时出现
|
||
- navigation.footer #页脚将呈现在边栏中，但在移动设备上保持原样
|
||
- search.suggest # 搜索输入一些字母时推荐补全整个单词
|
||
- search.highlight # 搜索出的文章关键词加入高亮
|
||
- search.share #搜索分享按钮
|
||
- navigation.expand # 打开Tab时左侧目录全部展开
|
||
- navigation.indexes #启用节索引页后，可以将文档直接附加到节
|
||
- content.tabs.link
|
||
- content.tooltips
|
||
- content.code.copy #代码复制
|
||
- content.action.edit
|
||
- content.action.view
|
||
- content.code.annotate
|
||
# - navigation.instant
|
||
#- header.autohide #自动隐藏
|
||
# - navigation.tabs.sticky #启用粘性选项卡后，导航选项卡将锁定在标题下方，并在向下滚动时始终保持可见
|
||
language: zh # 一些提示性的文字会变成中文
|
||
|
||
icon:
|
||
repo: fontawesome/brands/github #右上角图标
|
||
logo: logo
|
||
previous: fontawesome/solid/angle-left
|
||
# top: fontawesome/solid/angles-up
|
||
alternate: fontawesome/solid/language
|
||
edit_uri: edit/main/docs # 编辑按钮跳转的链接
|
||
repo_url: https://github.com/Wcowin/Mkdocs-Wcowin # 右上角点击跳转的链接
|
||
repo_name: Mkdocs-Wcowin # 右上角的名字
|
||
|
||
# [Navigtion]
|
||
nav:
|
||
# - 主页: index.md
|
||
- MKdocs中文教程:
|
||
- 许可声明: blog/MIT.md
|
||
- MKdocs教程(三部曲):
|
||
- 0.Mkdocs教程前言: blog/Mkdocs/mkfirst.md
|
||
- 1.利用Mkdocs部署静态网页: blog/Mkdocs/mkdocs1.md
|
||
- 2.Mkdocs配置说明(mkdocs.yml): blog/Mkdocs/mkdocs2.md
|
||
- 3.解决Github Pages部署mkdocs自定义域名失效的问题: blog/Mkdocs/mkdocs3.md
|
||
- Mkdocs美化:
|
||
- 添加Mkdocs博客: blog/Mkdocs/mkdocsblog.md
|
||
- 网页圆角化设计: blog/websitebeauty/yuanjiaohua.md
|
||
- 添加评论系统(giscus为例): blog/websitebeauty/mkcomments.md
|
||
- 添加在线聊天: blog/websitebeauty/webtalknow.md
|
||
- 添加友链: blog/websitebeauty/linktech.md
|
||
- 添加顶部公告栏: blog/websitebeauty/header.md
|
||
- 修改网站字体: blog/websitebeauty/mkdocsfont.md
|
||
- JS实现鼠标样式: blog/websitebeauty/shubiao.md
|
||
- 背景特效: blog/websitebeauty/backgroud.md
|
||
- 添加404页面: blog/websitebeauty/404.md
|
||
- 为MKdocs添加文章修订时间戳: blog/websitebeauty/time.md
|
||
- 建设MKdocs技能指北:
|
||
- Markdown:
|
||
- Markdown指南: develop/Markdown/markdown.md
|
||
- MWeb Pro: develop/Markdown/MWeb.md
|
||
- Git 实用技巧: develop/git.md
|
||
- 利用Lighthouse测试网站性能: develop/lighthouse.md
|
||
- 如何将 github pages 迁移到 vercel 上托管: develop/vercel.md
|
||
- 设计美学:
|
||
- 唐·诺曼—情感设计的三个层次: develop/designbeauty/db1.md
|
||
- 我对设计的一些观点: develop/designbeauty/my-to-desihn.md
|
||
|
||
- 标签: tag.md
|
||
- 留言板: liuyanban.md
|
||
- 博客:
|
||
- index: blog/index.md
|
||
- 友链:
|
||
- 友链: about/link.md
|
||
- 关于:
|
||
- 作者个人简介: about/geren.md
|
||
- 个人简历: about/resume.md
|
||
- 功能测试: about/test.md
|
||
- 个人博客: https://wcowin.work
|
||
- 使用本主题: https://github.com/new?template_name=Mkdocs-Wcowin&template_owner=Wcowin
|
||
|
||
copyright: Copyright © 2022~2025 Wcowin # 左下角的版权声明
|
||
|
||
extra:
|
||
alternate:
|
||
- name: 简体中文
|
||
link: /
|
||
# https://wcowin-work.translate.goog/?_x_tr_sl=auto&_x_tr_tl=en&_x_tr_hl=zh-CN&_x_tr_pto=wapp
|
||
lang: zh
|
||
- name: English
|
||
link: /Mkdocs-Wcowin/en/
|
||
# https://wcowin-work.translate.goog/?_x_tr_sl=auto&_x_tr_tl=en&_x_tr_hl=zh-CN&_x_tr_pto=wapp
|
||
lang: en
|
||
- name: China(TW)
|
||
link: /Mkdocs-Wcowin/ZH-TW/
|
||
# https://wcowin-work.translate.goog/?_x_tr_sl=zh-CN&_x_tr_tl=zh-TW&_x_tr_hl=zh-CN&_x_tr_pto=wapp
|
||
lang: zh-TW
|
||
generator: true #是否删除页脚显示“使用 MkDocs 材料制造”
|
||
social:
|
||
- icon: fontawesome/brands/weixin
|
||
link: https://s1.imagehub.cc/images/2024/02/02/bb9ee71b03ee7a3b87caad5cc4bcebff.jpeg
|
||
name: Wechat
|
||
- icon: fontawesome/brands/telegram
|
||
link: https://t.me/wecowin
|
||
name: telegram
|
||
- icon: fontawesome/brands/x-twitter #联系方式图标 : https://fontawesome.com/ 去这里找图标
|
||
link: https://twitter.com/wcowin_
|
||
- icon: fontawesome/brands/github
|
||
link: https://github.com/Wcowin
|
||
|
||
- icon: fontawesome/regular/envelope #联系方式图标
|
||
link: mailto:<wangkewen821@gmail.com> #邮件联系方式
|
||
- icon: fontawesome/brands/bilibili
|
||
link: https://space.bilibili.com/1407028951/lists/4566631?type=series
|
||
analytics:
|
||
provider: google #谷歌分析
|
||
property: G-29HZMNR0KG ##如果你 clone 了my模板，请将这个修改为你的
|
||
|
||
# 网页底部反馈
|
||
feedback:
|
||
title: 此页面有帮助吗？
|
||
ratings:
|
||
- icon: material/thumb-up-outline #图标可自定义
|
||
name: This page was helpful
|
||
data: 1
|
||
note: >-
|
||
谢谢你的反馈！
|
||
- icon: material/thumb-down-outline
|
||
name: This page could be improved
|
||
data: 0
|
||
note: >-
|
||
Thanks for your feedback! Help us improve this page by
|
||
using our <a href="https://marketingplatform.google.com/about/analytics/" target="_blank" rel="noopener">feedback form</a>.
|
||
# cookies设置（可选）
|
||
# consent:
|
||
# title: Cookie consent
|
||
# description: >-
|
||
# 我们也使用cookies来识别您的重复访问和偏好来衡量我们文档的有效性以及用户是否找到他们要找的东西。
|
||
# 如果你同意,你可以帮助我们让我们的网站更好
|
||
|
||
plugins:
|
||
- search #搜索配置
|
||
# - glightbox:
|
||
# enabled: !ENV [glightbox, false]
|
||
# touchNavigation: true
|
||
# loop: false
|
||
# effect: fade
|
||
# slide_effect: slide
|
||
# width: 100%
|
||
# height: auto
|
||
# zoomable: true
|
||
# draggable: true
|
||
# skip_classes:
|
||
# - custom-skip-class-name
|
||
# auto_caption: false
|
||
# caption_position: bottom
|
||
# background: white
|
||
# shadow: true
|
||
# manual: false
|
||
- git-committers:
|
||
enabled: !ENV [CI, false]
|
||
repository: Wcowin/Mkdocs-Wcowin
|
||
branch: main
|
||
exclude:
|
||
- index.md
|
||
- tag.md
|
||
- liuyanban.md
|
||
- blog/posts/update.md
|
||
- blog/posts/wkw.md
|
||
- about/link.md
|
||
- git-revision-date-localized:
|
||
enabled: !ENV [CI, false]
|
||
type: iso_date
|
||
enable_creation_date: false
|
||
exclude:
|
||
- index.md
|
||
- tag.md
|
||
- liuyanban.md
|
||
- blog/posts/update.md
|
||
- blog/posts/wkw.md
|
||
- about/link.md
|
||
- websitebeauty/linktech.md
|
||
- blog: #博客配置
|
||
post_date_format: full #时间
|
||
draft: true
|
||
draft_if_future_date: true #自动将具有未来日期的帖子标记为草稿
|
||
post_readtime: true
|
||
post_readtime_words_per_minute: 265 #计算帖子的阅读时间时读者每分钟预计阅读的字数
|
||
post_url_format: "{date}/{slug}"
|
||
# categories_slugify: !!python/object/apply:pymdownx.slugs.slugify
|
||
# kwds:
|
||
# case: lower
|
||
pagination_url_format: "page/{page}"
|
||
authors_file: "{blog}/.authors.yml" #作者信息
|
||
- tags
|
||
|
||
markdown_extensions: #详见https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/ 和 https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
|
||
- abbr
|
||
- attr_list
|
||
- admonition
|
||
- def_list
|
||
- footnotes
|
||
- md_in_html
|
||
# - meta # 支持Markdown文件上方自定义标题标签等
|
||
- pymdownx.caret
|
||
- pymdownx.betterem
|
||
- pymdownx.critic
|
||
- pymdownx.details
|
||
- pymdownx.inlinehilite
|
||
- pymdownx.keys
|
||
- pymdownx.mark
|
||
- pymdownx.snippets
|
||
- pymdownx.smartsymbols
|
||
- pymdownx.tilde
|
||
- pymdownx.superfences:
|
||
custom_fences:
|
||
- name: mermaid
|
||
class: mermaid
|
||
format:
|
||
!!python/name:pymdownx.superfences.fence_code_format # 代码块高亮插件
|
||
- pymdownx.arithmatex: # latex支持
|
||
generic: true
|
||
- toc:
|
||
permalink: true # 固定标题位置为当前位置
|
||
- pymdownx.highlight: # 代码块高亮
|
||
anchor_linenums: true
|
||
linenums: true # 显示行号
|
||
# auto_title: true # 显示编程语言名称
|
||
- pymdownx.emoji:
|
||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||
- pymdownx.tabbed:
|
||
alternate_style: true
|
||
- pymdownx.tasklist:
|
||
custom_checkbox: true
|
||
# - markdown.extensions.toc:
|
||
# slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
|
||
# permalink: "\ue157"
|
||
|
||
extra_javascript:
|
||
# - javascripts/extra.js #自定义javascript
|
||
- https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/javascripts/extra.js # extra的cdn
|
||
# - javascripts/mathjax.js #Latex支持
|
||
- https://github.com/Wcowin/Wcowin.github.io/blob/main/docs/javascripts/mathjax.js #Latex支持的CDN
|
||
- https://polyfill.io/v3/polyfill.min.js?features=es6 #Latex支持
|
||
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js #Latex支持
|
||
# - ckplayer/js/ckplayer.js #播放器配置
|
||
# - https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.min.js #gitalk支持
|
||
# - https://cdn.jsdelivr.net/npm/mermaid@10.0.2/dist/add-html-label-6e56ed67.min.js #忘了
|
||
- https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/javascripts/view.js
|
||
|
||
extra_css:
|
||
- stylesheets/extra.css # 自定义CSS
|
||
# - stylesheets/link.css #友链配置
|
||
- https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/link.css #友链CDN
|
||
# - stylesheets/customize.css # 搜索圆角优化
|
||
- https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/customize.css #按钮圆角化CDN
|
||
# - assets/stylesheets/portfolio.css
|
||
# - stylesheets/video.css #播放器可选配置
|
||
# - https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.css #gitalk支持
|
||
# - ckplayer/css/ckplayer.css #播放器配置
|
||
# - https://cdn.staticfile.org/font-awesome/4.7.0/css/font-awesome.css # font-awesome表情支持
|
||
# - https://cdnjs.cloudflare.com/ajax/libs/social-share.js/1.0.16/css/share.min.css #分享支持
|
||
|
||
# - https://cdn.jsdelivr.net/npm/lxgw-wenkai-webfont@1.1.0/style.css #字体
|
||
# - https://static.zeoseven.com/zsft/292/main/result.css #字体
|
||
# - stylesheets/ziti.css #字体
|
||
- https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/ziti.css
|
||
# - https://cdn.jsdelivr.net/npm/lxgw-wenkai-lite-webfont@1.1.0/style.css #字体
|
||
# - https://cdn.jsdelivr.net/npm/lxgw-wenkai-tc-webfont@1.0.0/style.css #字体
|
||
# - https://cdn.jsdelivr.net/npm/lxgw-wenkai-screen-webfont@1.1.0/style.css #字体
|
||
|
||
|
||
hooks:
|
||
- docs/overrides/hooks/socialmedia.py |