This commit is contained in:
Wcowin 2023-10-14 11:14:32 +08:00
parent 575aaea5e9
commit 8bedc9007f
10 changed files with 336 additions and 326 deletions

167
README-CN.md Normal file
View File

@ -0,0 +1,167 @@
---
title: 利用Mkdocs部署静态网页至GitHubpages
tags:
- Mkdocs
---
!!! info
官方网站:[MkDocs](https://www.mkdocs.org/){target=“_blank”}
我的个人网站成果:<http://wcowin.work/>{target=“_blank”}
## 一、准备工作(重要)
1.下载[Github Desktop](https://github.com/desktop/desktop){target=“_blank”}
2.有一个GitHub账号
3.打开电脑终端安装mkdocs: `pip install mkdocs-material`
***
## 二、Creating your site
参考教程:
[利用mkdocs部署静态网页至GitHubpages更新版](https://blog.csdn.net/m0_63203517/article/details/129755527?spm=1001.2014.3001.5501){target=“_blank”}
与其他教程不同我首先建议先在Github创建一个名为你的名字+github.io的仓库(不是这个名字的仓库也可以,你需要类比一下)
![img](https://cn.mcecy.com/image/20230324/51a12510e3b332b6ceea6827f40c1f2f.png)
![img](https://cn.mcecy.com/image/20230324/7f19bb393e39fb9add953ee19f9e2d91.png)
然后打开github Desktop 克隆到本地
![img](https://cn.mcecy.com/image/20230324/ff3682428cc987cad79625951ef6d7bc.png)
![img](https://cn.mcecy.com/image/20230324/e896de95bd6fa737e7c6c3fa21c079fb.png)
![img](https://cn.mcecy.com/image/20230324/791834a5ac01c95ef174ab77d47c0f3a.png)
![img](https://cn.mcecy.com/image/20230324/80430d0f8be7ea09368c3e63fe5a91ff.png)
打开Wcowin.github.io目录进入终端运行:
```
mkdocs new mkdocs-site
```
出现下图的几个文件
![img](https://cn.mcecy.com/image/20230324/2f3f28cb5ee726ac154102de2ffb43da.png)
docs文件下是以后网站的内容mkdocs.yml是配置文件配置主题目录插件等
你在这个目录下写的任何东西都可以通过github Desktop 上传到github上
以VScode为例我们打开具体看看里面的东西
(必须先执行下面的代码添加一个GitHub Workflow)
```
mkdir .github
cd .github
mkdir workflows
cd workflows
vim PublishMySite.yml
```
在PublishMySite.yml里面输入以下内容
```
name: publish site
on: # 在什么时候触发工作流
push: # 在从本地main分支被push到GitHub仓库时
branches:
- main
pull_request: # 在main分支合并别人提的pr时
branches:
- main
jobs: # 工作流的具体内容
deploy:
runs-on: ubuntu-latest # 创建一个新的云端虚拟机 使用最新Ubuntu系统
steps:
- uses: actions/checkout@v2 # 先checkout到main分支
- uses: actions/setup-python@v2 # 再安装Python3和相关环境
with:
python-version: 3.x
- run: pip install mkdocs-material # 使用pip包管理工具安装mkdocs-material
- run: mkdocs gh-deploy --force # 使用mkdocs-material部署gh-pages分支
```
!!!重点来了
仓库setings/Actions/General 勾选这两项
![](https://cn.mcecy.com/image/20231014/60f48ab66eea11b52f572b8fd489ea92.png)
目录树状图:
```
$ tree -a
.
├── .github
│ ├── .DS_Store
│ └── workflows
│ └── PublishMySite.yml
├── docs
│ └── index.md
└── mkdocs.yml
```
## 三、配置完善
打开终端运行
`pip install mkdocs-material`
打开**mkdocs.yml**
把以下的内容输入进去(最简单配置)
```
site_name: 网站名字
```
```
site_url: 网站链接
```
```
site_author: 你的名字
```
```
theme:
name: material #主题
```
详细mkdocs.yml配置见[Changing the colors - Material for MkDocs](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/)
[下次](https://blog.csdn.net/m0_63203517/article/details/127444446?spm=1001.2014.3001.5502)我会具体谈谈这个问题
***
在下方终端运行可以在浏览器看到实时网站
```
mkdocs serve
```
![img](https://cn.mcecy.com/image/20230324/f11af9fb64a8418181bc3655a88d8635.png)
![img](https://cn.mcecy.com/image/20230324/c745b71840c17d639e1ea144bc8c5732.png)
这个网站就算是初步建好了
最后去github Desktop上传到github
![img](https://cn.mcecy.com/image/20230324/53ad3fdbe7d05668b99a46780930845a.png)
!!!重点来了
去setings/pages 选择下图示意的路径
![](https://cn.mcecy.com/image/20231014/ac6d1bc1a236737a18d9dd6bd2bd97dc.png)
你的网站网址就是:​
```
https://你github的名字.github.io/ (根据仓库名改变)
```
![img](https://cn.mcecy.com/image/20230324/51a12510e3b332b6ceea6827f40c1f2f.png)
## 快速开始
打开终端安装mkdocs: `pip install mkdocs-material`,在你第二步克隆到本地的文件夹下(比如我的就是Wcowin.github.io这个文件夹)的终端执行`git clone git@github.com:Wcowin/Mkdocs-Wcowin.git`克隆本模版,把Mkdocs-Wcowin文件里的文件复制出来到Wcowin.github.io文件里随后在Wcowin.github.io文件目录终端里`mkdocs serve`即可
为了测试随手建的名为1的文件夹
![](https://cn.mcecy.com/image/20231014/f94d765bd86d56d35f7d558270d21bd5.png)
完美运行!
![](https://cn.mcecy.com/image/20231014/af910d370c91e06b8a6fc2e11ae3c6c9.png)
**浏览器进入<http://127.0.0.1:8000/>{target=“_blank”}即可看到端口网页效果**
下次谈谈网站的[mkdocs.yml具体配置](mkdocs2.md)
[^注]:于2023.3.24重写此文

View File

@ -1,21 +1,42 @@
# Mkdocs-Wcowin主题 # Mkdocs-Wcowin主题
- 基于Material for MkDocs美化 **- 基于Material for MkDocs美化**
- 简洁美观,功能多元化 **- 简洁美观,功能多元化**
- 简单易上手,小白配置 **- 可自定义样式,中文教程详细**
- 𝕙𝕒𝕧𝕖 𝕒 𝕘𝕠𝕠𝕕 𝕥𝕚𝕞𝕖 ! **- 简单易上手,小白配置**
**- 𝕙𝕒𝕧𝕖 𝕒 𝕘𝕠𝕠𝕕 𝕥𝕚𝕞𝕖 !**
# 展示
![](https://cn.mcecy.com/image/20231014/cda59880832afc0431a15b5c1ccc2203.png)
![](https://cn.mcecy.com/image/20231014/589c5daf1c07116225ea93131b7a1a36.png)
# Connect with me
## 如何快速使用
打开终端安装mkdocs: `pip install mkdocs-material`,在你第二步克隆到本地的文件夹下(我的就是Wcowin.github.io这个文件夹)的终端执行`git clone git@github.com:Wcowin/Mkdocs-Wcowin.git`克隆本模版,把Mkdocs-Wcowin文件里的文件复制出来到Wcowin.github.io文件里随后在Wcowin.github.io文件目录终端里`mkdocs serve`即可
为了测试随手建的名为1的文件夹
![](https://cn.mcecy.com/image/20231014/f94d765bd86d56d35f7d558270d21bd5.png)
详细的初步教程见:[利用Mkdocs部署静态网页至GitHubpages](README-CN.md)
## 展示
<center> <center>
**MuseLink** **主页**
![](https://cn.mcecy.com/image/20231014/cda59880832afc0431a15b5c1ccc2203.png)
**文章页**
![](https://cn.mcecy.com/image/20231014/589c5daf1c07116225ea93131b7a1a36.png)
**博客页**
![](https://cn.mcecy.com/image/20231014/404bafe5eb3d7259638e442b2c31729b.png)
**标签页**
![](https://cn.mcecy.com/image/20231014/425bf7fef96dd23e80b0c32da0819c5e.png)
**简洁的友链页面**
![](https://cn.mcecy.com/image/20231014/a6272231f79b3ebd1c91add55be5ec5e.png)
**页面底部**
![](https://cn.mcecy.com/image/20231014/4631396ede3295cdba9176fbb6b9e02c.png)
</center>
## Connect with me
<center>
<p> <p>
<a href="https://muselink.cc/Wcowin" target="_blank"> <a href="https://muselink.cc/Wcowin" target="_blank">
@ -23,6 +44,7 @@
</a> </a>
</p> </p>
**MuseLink**
</center> </center>
@ -33,5 +55,5 @@
[![Star History Chart](https://api.star-history.com/svg?repos=Wcowin/Mkdocs-Wcowin&type=Date)](https://star-history.com/#Wcowin/Mkdocs-Wcowin&Date) [![Star History Chart](https://api.star-history.com/svg?repos=Wcowin/Mkdocs-Wcowin&type=Date)](https://star-history.com/#Wcowin/Mkdocs-Wcowin&Date)
## 感谢各位朋友

View File

@ -74,7 +74,7 @@ hide:
<img class="ava" src="https://gravatar.cdn.iszy.xyz/avatar/5012e410377c7a93d14f7bf31aeeb7fd?d=mm" /> <img class="ava" src="https://gravatar.cdn.iszy.xyz/avatar/5012e410377c7a93d14f7bf31aeeb7fd?d=mm" />
<div class="card-header"> <div class="card-header">
<div> <div>
<a href="https://macapp.org.cn/" target=“_blank”>随遇而安</a> <a href="https://www.iszy.cc/" target=“_blank”>随遇而安</a>
</div> </div>
<div class="info"> <div class="info">
生活吐槽&学习记录 生活吐槽&学习记录
@ -85,27 +85,6 @@ hide:
</div> </div>
</div> </div>
<!-- <div class="card">
<img class="ava" src="https://cn.mcecy.com/image/20231012/d96b912437fb0bec0d282dfe734b1d9b.jpeg" />
<div class="card-header">
<div>
<a href="https://macapp.org.cn/" target=“_blank”>Macapp</a>
</div>
<div class="info">
专注于分享Mac资源的频道
</div>
</div>
</div> -->
<!-- <div class="markdown-content">
<h2>欢迎加入友链</h2>
</div>
详见:[如何给MKdocs添加友链](../blog/Mkdocs/linktech.md) -->
<!-- <div class="card"> <!-- <div class="card">
<img class="ava" src="{avatarurl}" /> <img class="ava" src="{avatarurl}" />
<div class="card-header"> <div class="card-header">

View File

@ -12,27 +12,22 @@ tags:
我把我目前的部分配置文件mkdocs.yml代码写在下面👇🏻 我把我目前的部分配置文件mkdocs.yml代码写在下面👇🏻
```yml ```yml
#[Info] #[Info]
site_name: Wcowin's Web site_name: Mkdocs-Wcowin中文主题 #your site name 显示在左上角
site_url: http://wcowin.work/ site_url: http://wcowin.work/Mkdocs-Wcowin
site_author: 王科文(Wcowin) site_author: Wcowin # your name
#[UI] #[UI]
theme: theme:
name: material name: material
custom_dir: overrides custom_dir: overrides #覆写路径
# custom_dir: material/.overrides # font: #谷歌字体,自行搜索
# font: # text: Bitter #文本字体
# text: Bitter # code: Roboto Mono #代码字体
# code: Roboto Mono logo: #左上角logo,可插入图片链接
logo: https://cn.mcecy.com/image/20231006/a05f708fb7b0426e7a5786669d5b1386.png
# material/library favicon: img/apple-line.png # 网页icon
# admonition:
# <type>: material/file-alert-outline
favicon: img/apple-line.png
# img/11.ico
palette: palette:
#primary: blue grey #明暗按钮
- media: "(prefers-color-scheme: light)" - media: "(prefers-color-scheme: light)"
scheme: default # 日间模式 scheme: default # 日间模式
primary: blue grey # 上方的 primary: blue grey # 上方的
@ -49,6 +44,7 @@ theme:
toggle: toggle:
icon: material/weather-sunny icon: material/weather-sunny
name: 切换至日间模式 name: 切换至日间模式
features: features:
- announce.dismiss #呈现可标记为由用户读取的临时公告,可以包含一个用于取消当前公告的按钮 - announce.dismiss #呈现可标记为由用户读取的临时公告,可以包含一个用于取消当前公告的按钮
# - navigation.instant # - navigation.instant
@ -66,7 +62,7 @@ theme:
- navigation.indexes #启用节索引页后,可以将文档直接附加到节 - navigation.indexes #启用节索引页后,可以将文档直接附加到节
- content.tabs.link - content.tabs.link
- content.tooltips - content.tooltips
- content.code.copy - content.code.copy #代码复制
- content.action.edit - content.action.edit
- content.action.view - content.action.view
- content.code.annotate - content.code.annotate
@ -76,193 +72,46 @@ theme:
icon: icon:
repo: fontawesome/brands/github #右上角图标 repo: fontawesome/brands/github #右上角图标
edit_uri: edit/main/docs # 编辑按钮跳转的链接 edit_uri: edit/main/docs # 编辑按钮跳转的链接
repo_url: https://github.com/Wcowin/Wcowin.github.io # 右上角点击跳转的链接 repo_url: https://github.com/Wcowin/Mkdocs-Wcowin # 右上角点击跳转的链接
repo_name: Wcowin.github.io # 右上角的名字 repo_name: Mkdocs-Wcowin # 右上角的名字
# [Navigtion] # [Navigtion]
nav: nav:
# - 主页: index.md # - 主页: index.md
- 博文: - MKdocs中文教程:
- 好用/好玩网站分享: blog/Webplay.md
- Mac/windows软件网站汇总: blog/macsoft.md
- 语雀: blog/yuque.md
- Telegram 群组、频道、机器人 汇总分享: blog/TG.md
- MKdocs教程: - MKdocs教程:
- 利用mkdocs部署静态网页至GitHub pages: blog/Mkdocs/mkdocs1.md - 利用mkdocs部署静态网页至GitHub pages: blog/Mkdocs/mkdocs1.md
- Mkdocs部署静态网页至GitHub pages配置说明(mkdocs.yml): blog/Mkdocs/mkdocs2.md - Mkdocs部署静态网页至GitHub pages配置说明(mkdocs.yml): blog/Mkdocs/mkdocs2.md
- 解决 mkdocs部署 Github Pages 自定义域名失效的问题: blog/Mkdocs/mkdocs3.md - 解决 mkdocs部署 Github Pages 自定义域名失效的问题: blog/Mkdocs/mkdocs3.md
- 设置Mkdocs博客: blog/Mkdocs/mkdocsblog.md - 添加Mkdocs博客: blog/Mkdocs/mkdocsblog.md
- Mkdocs美化: - Mkdocs美化:
- 添加评论系统(giscus为例): blog/websitebeauty/mkcomments.md
- 添加在线聊天: blog/websitebeauty/webtalknow.md
- 添加友链: blog/websitebeauty/linktech.md
- 添加顶部公告栏: blog/websitebeauty/header.md
- 修改网站字体: blog/websitebeauty/mkdocsfont.md - 修改网站字体: blog/websitebeauty/mkdocsfont.md
- JS实现鼠标样式: blog/websitebeauty/shubiao.md - JS实现鼠标样式: blog/websitebeauty/shubiao.md
- 背景特效: blog/websitebeauty/backgroud.md - 背景特效: blog/websitebeauty/backgroud.md
- 技术分享: - 建设MKdocs技能指北:
- Win11镜像下载、壁纸及KMS激活 : blog/technique sharing/win.md
- 实用脚本分享: blog/technique sharing/jiaoben.md
- 搭建个人图床: blog/technique sharing/tuchuang.md
- oh-my-zsh 更新: blog/technique sharing/ohmuzsh.md
- 解决谷歌翻译用不了的问题: blog/technique sharing/googletranslate.md
- 爱心代码: blog/technique sharing/aixin.md
- 用Matlab画玫瑰百合花: blog/technique sharing/matlabrose.md
- 科学上网: blog/technique sharing/kexue.md
- 计算机编年史: blog/technique sharing/jisuanjibiannianshi.md
- 学术:
- LaTeX常用符号整理: blog/Academic/LaTeX.md
- Math: blog/Academic/math.md
- 数学竞赛:
- 第十四届全国大学生数学竞赛(非数学类)初赛补赛详细解答: blog/Academic/Math/14.md
- 第十三届全国大学生数学竞赛(非数学类)决赛详细解答: blog/Academic/Math/13js.md
- Mac:
- PD虚拟机: blog/Mac/Pd.md
- 提示 「“XXX”已损坏,无法打开。 您应该将它移到废纸篓。」「打不开 xxx,因为它来自身份不明的开发者」解决方法: blog/Mac/sunhuai.md
- Macbook启动台顽固应用图标删除方法: blog/Mac/shanchu.md
- Homebrew国内如何自动安装(国内地址)(Mac & Linux): blog/Mac/homebrew.md
- mac 无法访问 github 的解决办法: blog/Mac/jiasugithub.md
- Mac的esc键失效的解决方法: blog/Mac/Macesc.md
- 启动台图标顺序错乱怎么办: blog/Mac/Launchpad.md
- Mac小技巧:去除系统截图名的日期后缀: blog/Mac/jietu.md
- 小小Mac技巧: blog/Mac/xjiq.md
- Mac隐藏彩蛋: blog/Mac/maccd.md
- Mac 键盘快捷键: blog/Mac/kjj.md
- iPhone:
- iphone多账号如何不频繁登录,双重认证: blog/iphone/iphoneduozhanghao.md
- 苹果iphone /iOS 限免网站合集: blog/iphone/iphonexianmian.md
- 苹果手机如何去除开屏广告: blog/iphone/iphonequchukaiping.md
- WIN:
- 彻底卸载360安全卫士的方法: blog/Win/360.md
- 三步卸载 Microsoft Edge: blog/Win/edgexz.md
- windows快捷键: blog/Win/winkjj.md
- 安卓的子系统: blog/Win/anzhuodezixit.md
- Python:
- 将Python文件.py打包成.exe可执行程序: blog/py/python.md
- pip: blog/py/pip.md
- C语言:
- C笔记: blog/C language/c.md
- 开发:
- 我的设备: develop/mydevice.md
- 如何注册ChatGPT: develop/ChatGPT.md
- Markdown: - Markdown:
- Markdown指南: develop/Markdown/markdown.md - Markdown指南: develop/Markdown/markdown.md
- MWeb Pro: develop/Markdown/MWeb.md - MWeb Pro: develop/Markdown/MWeb.md
- Git 实用技巧: develop/git.md - Git 实用技巧: develop/git.md
- 我的作品: - 利用Lighthouse测试网站性能: develop/lighthouse.md
# - 基于讯飞人脸算法进行人脸比对(调用API): develop/Mywork/face_compare.md - 如何将 github pages 迁移到 vercel 上托管: develop/vercel.md
# - 人脸识别系统: develop/Mywork/face-recognition.md
- 基于百度API和opencv的智能车牌识别程序: develop/Mywork/opencv.md
- 利用百度API进行植物识别: develop/Mywork/aizhiwu.md
- 玩的设计: develop/Mywork/design.md
- 设计美学: - 设计美学:
- 唐·诺曼—情感设计的三个层次: develop/designbeauty/db1.md - 唐·诺曼—情感设计的三个层次: develop/designbeauty/db1.md
- 我对设计的一些观点: develop/designbeauty/my-to-desihn.md - 我对设计的一些观点: develop/designbeauty/my-to-desihn.md
- 1024code: develop/1024code.md
- 利用Lighthouse测试网站性能: develop/lighthouse.md
- What is Github: develop/Github.md
- 如何将 github pages 迁移到 vercel 上托管: develop/vercel.md
- 大厂们的良心软件~: develop/fenxiang.md
- 写给所有 Mac 用户的摸鱼指北: develop/Mac.md
- 看源码才懂: develop/kanyuanma.md
- 闲话:
- 推荐的Books: relax/tuijianyuedu.md
- 小米: relax/xiaomo.md
- Apple: relax/Apple.md
- 如是我闻: relax/rushiwowen.md
- 王冰冰o(^▽^)o: relax/wbb.md
- 诗文:
- 枫桥夜泊: relax/shiwen/fqyb.md
- 滕王阁序: relax/shiwen/twgx.md
- 望江南·超然台作: relax/shiwen/sjcnh.md
- 击鼓: relax/shiwen/jg.md
- 雨霖铃·秋别: relax/shiwen/yll.md
- 江城子·乙卯正月二十日夜记梦: relax/shiwen/jcz.md
- 数至十:
- 1: relax/wkwMath/1.md
- 2: relax/wkwMath/2.md
- 3: relax/wkwMath/3.md
- 4: relax/wkwMath/4.md
- 5: relax/wkwMath/5.md
# - 诗经: relax/shiwen/shijing.json
- 观影:
- 推荐的番剧: relax/Movie/tuijianfanju.md
- 推荐的电影: relax/Movie/tuijiandedianyin.md
- 推荐的电视剧: relax/Movie/tuijiandsj.md
- 杂文:
- 《目送》节选: relax/Essay/musong.md
- 大学一个人吃饭很丢人吗?: relax/Essay/dx.md
- luv letter: relax/Essay/luv letter.md
- 有哪些给男孩子在谈恋爱时的忠告?: relax/Essay/zhonggao.md
- 哈基米🐈: relax/Essay/cat.md
- 程序人生:
- 《程序员成长历程的四个阶段》: relax/Manong/sigejieduan.md
- 《程序员脱单指南》: relax/Manong/tuodanbukeneng.md
- 《程序员学习路线图》: relax/Manong/wtf.md
- 《printf("❤️\n》: relax/Manong/cxiaoaixin.md
- 写信:
- 第一封: relax/Letter/letter1.md
- 第二封: relax/Letter/letter2.md
- 情书:
- 朱生豪与宋清如: relax/Letter/luvletter/sqrzszyz.md
- 《朱生豪情书全集摘录》(021): relax/Letter/luvletter/zhushenghao1.md
- 《朱生豪情书全集摘录》(031): relax/Letter/luvletter/zhushenghao2.md
- 《朱生豪情书全集摘录》(036): relax/Letter/luvletter/zhushenghao3.md
- 《朱生豪情书全集摘录》(046): relax/Letter/luvletter/zhushenghao4.md
- 《朱生豪情书全集摘录》(053): relax/Letter/luvletter/zhushenghao5.md
- 《朱生豪情书全集摘录》(055): relax/Letter/luvletter/zhushenghao6.md
# - Music:
# - shape of you: relax/Music/soy.md
# - Floating: relax/Music/Floating.md
# - 朱砂: relax/Music/zhusha.md
# - 关于郑州的记忆: relax/Music/gyzzdjy.md
# - 若把你: relax/Music/rbn.md
# - 絶頂讃歌: relax/Music/jdzg.md
- Game:
- 原神: relax/Game/yuanshen.md
- 如何玩好《王者荣耀》?: relax/Game/wzry.md
- 入党结业考试题总结: relax/rudang.md
- 润学之为什么润: about/run.md
- 让人说话,天塌不下来: about/maozedong.md
- 关于教育革命的谈话: relax/jiaoyu.md
- 程序猿神之楷模:一个人,一个网站,5.75亿美元卖掉: relax/kaimo.md
- 旅行:
# - trip/index.md
- 重庆:
- 重庆旅游推荐路线: trip/InCQ/CQ.md
- Hometown: trip/LH.md
- 西安: trip/Xian.md
- 标签: tag.md - 标签: tag.md
- 留言板: waline.md - 留言板: liuyanban.md
- 友链:
- 友链: about/link.md
- 如何给MKdocs添加友链: blog/Mkdocs/linktech.md
- Blogger: - Blogger:
- index: blog/index.md - index: blog/index.md
# - wkw: blog/posts/wkw.md - 友链:
# - 我的一些见解: blog/posts/post1.md - 友链: about/link.md
# - Lifecycle: blog/posts/post2.md
- 关于: - 关于:
- 个人简介: about/geren.md - 作者个人简介: about/geren.md
- 个人简历: about/个人简历2.pdf - 功能测试: about/test.md
- My Goal: about/goal.md
- Github主页介绍: about/Wcowin.md
- 网站制作: about/web.md
- 支持作者: about/zcw.md
- 毕业之前值得去做的30件事: about/biye.md
- 免责声明: about/shengming.md
- Test: about/test.md
- 404公益页面: about/404.md
- For lover: about/Foryou.md
@ -270,24 +119,26 @@ copyright: Copyright &copy; 2022~2023 Wcowin/All Rights Reserved. # 左下角的
extra: extra:
generator: true #删除页脚显示“使用 MkDocs 材料制造” generator: true #是否删除页脚显示“使用 MkDocs 材料制造”
social: social:
- icon: fontawesome/brands/x-twitter - icon: fontawesome/brands/x-twitter #联系方式图标 : https://fontawesome.com/ 去这里找图标
link: https://twitter.com/wcowin_ link: https://twitter.com/wcowin_
- icon: fontawesome/brands/github - icon: fontawesome/brands/github
link: https://github.com/Wcowin link: https://github.com/Wcowin
- icon: fontawesome/regular/envelope - icon: fontawesome/regular/envelope #联系方式图标
link: mailto:<wangkewen821@gmail.com> #联系方式 link: mailto:<wangkewen821@gmail.com> #邮件联系方式
- icon: fontawesome/brands/bilibili - icon: fontawesome/brands/bilibili
link: https://space.bilibili.com/1407028951?spm_id_from=333.1007.0.0 link: https://space.bilibili.com/1407028951?spm_id_from=333.1007.0.0
analytics: analytics:
provider: google provider: google #谷歌分析
property: G-29HZMNR0KG property:
# 网页底部反馈
feedback: feedback:
title: 此页面有帮助吗? title: 此页面有帮助吗?
ratings: ratings:
- icon: material/thumb-up-outline - icon: material/thumb-up-outline #图标可自定义
name: This page was helpful name: This page was helpful
data: 1 data: 1
note: >- note: >-
@ -298,7 +149,7 @@ extra:
note: >- note: >-
Thanks for your feedback! Help us improve this page by 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>. using our <a href="https://marketingplatform.google.com/about/analytics/" target="_blank" rel="noopener">feedback form</a>.
# cookies设置可选
# consent: # consent:
# title: Cookie consent # title: Cookie consent
# description: >- # description: >-
@ -308,9 +159,8 @@ extra:
plugins: plugins:
# - glightbox - search #搜索配置
- search - blog: #博客配置
- blog:
post_date_format: full #时间 post_date_format: full #时间
draft: true draft: true
draft_if_future_date: true #自动将具有未来日期的帖子标记为草稿 draft_if_future_date: true #自动将具有未来日期的帖子标记为草稿
@ -320,8 +170,6 @@ plugins:
categories_slugify: !!python/object/apply:pymdownx.slugs.slugify categories_slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds: kwds:
case: lower case: lower
# categories_toc: true
# pagination_per_page: 5
pagination_url_format: "page/{page}" pagination_url_format: "page/{page}"
authors_file: "{blog}/.authors.yml" #作者信息 authors_file: "{blog}/.authors.yml" #作者信息
- tags: - tags:
@ -329,7 +177,7 @@ plugins:
markdown_extensions: markdown_extensions: #详见https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/ 和 https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
- abbr - abbr
- attr_list - attr_list
- admonition - admonition
@ -372,57 +220,36 @@ markdown_extensions:
permalink: "\ue157" permalink: "\ue157"
extra_javascript: extra_javascript:
- javascripts/extra.js - javascripts/extra.js #自定义javascript
# - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/javascripts/extra.js # extra的cdn - javascripts/mathjax.js #Latex支持
- javascripts/mathjax.js - https://polyfill.io/v3/polyfill.min.js?features=es6 #Latex支持
- https://polyfill.io/v3/polyfill.min.js?features=es6 - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js #Latex支持
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js - ckplayer/js/ckplayer.js #播放器配置
# - javascripts/mathjax-config.js - https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.min.js #gitalk支持
# - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS_HTML - https://cdn.jsdelivr.net/npm/mermaid@10.0.2/dist/add-html-label-6e56ed67.min.js #忘了
- https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.min.js
# - ckplayer/js/ckplayer.js
# - https://cdnjs.cloudflare.com/ajax/libs/social-share.js/1.0.16/js/social-share.min.js
# - javascripts/backbound1.js
# - javascripts/rellax.min.js
- https://cdn.jsdelivr.net/npm/mermaid@10.0.2/dist/add-html-label-6e56ed67.min.js
# - https://res.zvo.cn/translate/translate.js # Translate
extra_css: extra_css:
- stylesheets/extra.css - stylesheets/extra.css # 自定义CSS
- stylesheets/link.css - stylesheets/link.css #友链配置
# - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/extra.css # extra.css的CDN # - stylesheets/video.css #播放器可选配置
# - stylesheets/extra1.css - https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.css #gitalk支持
# - stylesheets/video.css - ckplayer/css/ckplayer.css #播放器配置
- https://unpkg.com/@waline/client@v2/dist/waline.css - https://cdn.staticfile.org/font-awesome/4.7.0/css/font-awesome.css # font-awesome表情支持
- https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.css # - https://cdnjs.cloudflare.com/ajax/libs/social-share.js/1.0.16/css/share.min.css #分享支持
- ckplayer/css/ckplayer.css
- https://cdn.staticfile.org/font-awesome/4.7.0/css/font-awesome.css
# - 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://cdn.jsdelivr.net/npm/lxgw-wenkai-webfont@1.1.0/style.css #字体
# - https://cdn.jsdelivr.net/npm/lxgw-wenkai-lite-webfont@1.1.0/style.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-tc-webfont@1.0.0/style.css #字体
# - https://cdn.jsdelivr.net/npm/lxgw-wenkai-screen-webfont@1.1.0/style.css # - https://cdn.jsdelivr.net/npm/lxgw-wenkai-screen-webfont@1.1.0/style.css #字体
# crisp
# https://crisp.chat/en/
# crisp:
# enable: true
# website_id: 89ded6c2-1a10-47e3-af5d-f12e6a378547
# tidio:
# enable: true
# public_key: w3nvk9wmckvjf2iity4bwxicoj4yss9l
``` ```
*** ***
从头开始分析 从头开始分析
## 开头 ## 开头
``` ```yml
site_name: 网站名字 site_name: 网站名字
site_url: 网站网址 site_url: 网站网址
site_author: 作者名字 site_author: 作者名字
@ -433,7 +260,7 @@ site_author: 作者名字
### 颜色 ### 颜色
![img](https://cn.mcecy.com/image/20230324/0d60c4d1cc6399c654c78769a402ad56.png) ![img](https://cn.mcecy.com/image/20230324/0d60c4d1cc6399c654c78769a402ad56.png)
``` ```yml
theme: theme:
palette: palette:
primary: yellow #顶部颜色 primary: yellow #顶部颜色
@ -443,21 +270,26 @@ primary后面是网站顶部栏目的颜色也用于标题、边栏、文本
### 明暗主题按钮 ### 明暗主题按钮
![img](https://cn.mcecy.com/image/20230324/8654dc52f8c278bbf29eb94a8ffcb2da.png) ![img](https://cn.mcecy.com/image/20230324/8654dc52f8c278bbf29eb94a8ffcb2da.png)
``` ```yml
theme: theme:
palette: palette:
#明暗按钮
# Palette toggle for light mode - media: "(prefers-color-scheme: light)"
- scheme: default scheme: default # 日间模式
primary: blue grey # 上方的
accent: indigo # 链接等可交互元件的高亮色
# teal
toggle: toggle:
icon: material/brightness-7 icon: material/weather-night # 图标
name: Switch to dark mode name: 切换至夜间模式 # 鼠标悬浮提示
- media: "(prefers-color-scheme: dark)"
# Palette toggle for dark mode scheme: slate # 夜间模式
- scheme: slate primary: black
accent: indigo
# teal
toggle: toggle:
icon: material/brightness-4 icon: material/weather-sunny
name: Switch to light mode name: 切换至日间模式
``` ```
此配置将在搜索栏旁边呈现调色板切换。请注意您还可以为每个调色板的primary和accent定义单独的设置。 此配置将在搜索栏旁边呈现调色板切换。请注意您还可以为每个调色板的primary和accent定义单独的设置。
@ -466,7 +298,7 @@ theme:
*** ***
### features ### features
``` ```yml
features: features:
- navigation.instant #- header.autohide #自动隐藏 - navigation.instant #- header.autohide #自动隐藏
#- announce.dismiss #呈现可标记为由用户读取的临时公告,可以包含一个用于取消当前公告的按钮 #- announce.dismiss #呈现可标记为由用户读取的临时公告,可以包含一个用于取消当前公告的按钮
@ -506,14 +338,17 @@ nav:
.md文件路径(相对路径) .md文件路径(相对路径)
![img](https://cn.mcecy.com/image/20230324/2bcb22df954bda4dbe773ad096a039c6.png) ![img](https://cn.mcecy.com/image/20230324/2bcb22df954bda4dbe773ad096a039c6.png)
**所以说在docs里每写好一篇.md就要去mkdocs.yml中的nav里配置路径**
*** ***
这里也注意:**所有文件都在docs文件下文件类型除CSSJavascript等都是.md结尾的文件** 这里也注意:**所有文件都在docs文件下文件类型除CSSJavascript等都是.md结尾的文件**
所以强烈推荐去学习Maekdown、Html5、CSS3、Javascript等知识这样你就可以自定义你的网站了。 所以强烈推荐去学习[Markdown](https://wcowin.work/Mkdocs-Wcowin/develop/Markdown/markdown/)、Html5、CSS3、Javascript等知识这样你就可以自定义你的网站了。
到这里先检查一下文件树状图(xx.md代表你的md文件) 到这里先检查一下文件树状图(xx.md代表你的md文件)
``` ```yml
$ tree -a $ tree -a
. .
├── .github ├── .github
@ -528,7 +363,7 @@ $ tree -a
``` ```
*** ***
## extra部分 ## extra部分
``` ```yml
extra: extra:
generator: false #删除页脚显示“使用 MkDocs 材料制造” generator: false #删除页脚显示“使用 MkDocs 材料制造”
social: social:
@ -545,7 +380,7 @@ social部分可设置网站右下角的社交链接icon是小图标link后
![img](https://cn.mcecy.com/image/20230324/551cc1e17058617a8b5787bf6b1ba19a.png) ![img](https://cn.mcecy.com/image/20230324/551cc1e17058617a8b5787bf6b1ba19a.png)
cookie cookie
``` ```yml
analytics: analytics:
provider: google provider: google
property: G-XXXXXXXXXX #你的Google Analytics ID property: G-XXXXXXXXXX #你的Google Analytics ID
@ -594,7 +429,7 @@ plugins:
``` ```
![img](https://cn.mcecy.com/image/20230324/92fd3f17055fca8fc76f21b5fab5f76a.png) ![img](https://cn.mcecy.com/image/20230324/92fd3f17055fca8fc76f21b5fab5f76a.png)
docs文件夹下新建tags.md文件会自动在tags.md文件中生成标签列表 docs文件夹下新建tags.md文件会自动在tags.md文件中生成标签列表
但是每个.md文件最开始的地方都需要添加标签否则不会显示在tags.md文件中 但是每个.md文件最开始的地方都需要添加标签否则不会显示在tags.md文件中 **(如果不用则删掉.md文件开头的tag选项即可否则加上tag有可能报错)**
![img](https://cn.mcecy.com/image/20230324/7f0a3213cad72aa11f2185c7cae9a032.png) ![img](https://cn.mcecy.com/image/20230324/7f0a3213cad72aa11f2185c7cae9a032.png)
格式: 格式:
@ -603,16 +438,13 @@ docs文件夹下新建tags.md文件会自动在tags.md文件中生成标签
title: title:
tags: tags:
- 你的标签名字 - 你的标签名字
hide:
#- navigation # 显示右侧导航
#- toc #显示左侧导航
--- ---
``` ```
*** ***
## markdown_extensions部分 ## markdown_extensions部分
``` ```yml
markdown_extensions: markdown_extensions:
- abbr - abbr
- attr_list - attr_list
@ -659,14 +491,29 @@ markdown_extensions:
*** ***
## extra_javascript 和extra_css ## extra_javascript 和extra_css
``` ```yml
extra_javascript: extra_javascript:
- javascripts/extra.js - javascripts/extra.js #自定义javascript
- javascripts/mathjax.js - javascripts/mathjax.js #Latex支持
- https://polyfill.io/v3/polyfill.min.js?features=es6 - https://polyfill.io/v3/polyfill.min.js?features=es6 #Latex支持
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js - 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 #忘了
extra_css: extra_css:
- stylesheets/extra.css - stylesheets/extra.css # 自定义CSS
- stylesheets/link.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://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 #字体
``` ```
javascripts/mathjax.js里有对数学公式的扩展extra_css里是CSS的知识了及自定义网站格式颜色等 javascripts/mathjax.js里有对数学公式的扩展extra_css里是CSS的知识了及自定义网站格式颜色等
@ -678,3 +525,6 @@ javascripts/mathjax.js里有对数学公式的扩展extra_css里是CSS的知
[自定义网站字体](../websitebeauty/mkdocsfont.md) [自定义网站字体](../websitebeauty/mkdocsfont.md)
[添加友链](../websitebeauty/linktech.md)
[添加评论系统](../websitebeauty/mkcomments.md)

View File

@ -7,7 +7,7 @@ hide:
# - footer #隐藏翻页 # - footer #隐藏翻页
# - feedback #隐藏反馈 # - feedback #隐藏反馈
tags: tags:
- MKdocs - Mkdocs
comments: false #评论,默认不开启 comments: false #评论,默认不开启
--- ---

View File

@ -7,12 +7,6 @@ tags:
以下代码均在`docs/javascripts/extra.js`下复制粘贴 以下代码均在`docs/javascripts/extra.js`下复制粘贴
<!-- <head>
<script src="https://www.lanjie100.com/js/snow.user.js"></script>
</head> -->
<div id="snowflakes-container"></div> <div id="snowflakes-container"></div>
<script> <script>
// 在LocalStorage中设置不显示雪花效果的标志 // 在LocalStorage中设置不显示雪花效果的标志

View File

@ -7,12 +7,13 @@ hide:
# - footer #隐藏翻页 # - footer #隐藏翻页
# - feedback #隐藏反馈 # - feedback #隐藏反馈
tags: tags:
- MKdocs - Mkdocs
comments: false #评论,默认不开启 comments: false #评论,默认不开启
--- ---
![](https://cn.mcecy.com/image/20231014/28f7a934aed2790c02785638c06580c8.png) ![](https://cn.mcecy.com/image/20231014/28f7a934aed2790c02785638c06580c8.png)
overrides下新建main.html 针对main.html文件 overrides下新建main.html 针对main.html文件
树状结构如下 树状结构如下
![](https://cn.mcecy.com/image/20231013/c9e5930308a1e0369c43499cf8f73e27.png) ![](https://cn.mcecy.com/image/20231013/c9e5930308a1e0369c43499cf8f73e27.png)

View File

@ -30,6 +30,7 @@ theme:
custom_dir: overrides #主要是这一行 custom_dir: overrides #主要是这一行
``` ```
参考下图新建overrides文件在此文件下参考下图新建覆盖html文件 参考下图新建overrides文件在此文件下参考下图新建覆盖html文件
树状结构如下 树状结构如下
![](https://cn.mcecy.com/image/20231013/c9e5930308a1e0369c43499cf8f73e27.png) ![](https://cn.mcecy.com/image/20231013/c9e5930308a1e0369c43499cf8f73e27.png)

View File

@ -9,7 +9,7 @@ theme:
# font: #谷歌字体,自行搜索 # font: #谷歌字体,自行搜索
# text: Bitter #文本字体 # text: Bitter #文本字体
# code: Roboto Mono #代码字体 # code: Roboto Mono #代码字体
logo: #左上角logo可插入图片链接 logo: assets/favicon.png #左上角logo可插入图片链接
favicon: img/apple-line.png # 网页icon favicon: img/apple-line.png # 网页icon
@ -70,7 +70,7 @@ nav:
- 利用mkdocs部署静态网页至GitHub pages: blog/Mkdocs/mkdocs1.md - 利用mkdocs部署静态网页至GitHub pages: blog/Mkdocs/mkdocs1.md
- Mkdocs部署静态网页至GitHub pages配置说明(mkdocs.yml): blog/Mkdocs/mkdocs2.md - Mkdocs部署静态网页至GitHub pages配置说明(mkdocs.yml): blog/Mkdocs/mkdocs2.md
- 解决 mkdocs部署 Github Pages 自定义域名失效的问题: blog/Mkdocs/mkdocs3.md - 解决 mkdocs部署 Github Pages 自定义域名失效的问题: blog/Mkdocs/mkdocs3.md
- 网站添加Mkdocs博客: blog/Mkdocs/mkdocsblog.md - 添加Mkdocs博客: blog/Mkdocs/mkdocsblog.md
- Mkdocs美化: - Mkdocs美化:
- 添加评论系统(giscus为例): blog/websitebeauty/mkcomments.md - 添加评论系统(giscus为例): blog/websitebeauty/mkcomments.md
- 添加在线聊天: blog/websitebeauty/webtalknow.md - 添加在线聊天: blog/websitebeauty/webtalknow.md
@ -164,7 +164,7 @@ plugins:
markdown_extensions: markdown_extensions: #详见https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/ 和 https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
- abbr - abbr
- attr_list - attr_list
- admonition - admonition

View File

@ -91,11 +91,7 @@
{% include "partials/copyright.html" %} {% include "partials/copyright.html" %}
<!-- Social links --> <!-- Social links -->
<center> <!-- 在这里插入页脚 -->
<footer>
<a href="https://icp.gov.moe/?keyword=20230640" target="_blank">萌ICP备20230640号</a>
</footer>
</center>
{% if config.extra.social %} {% if config.extra.social %}
{% include "partials/social.html" %} {% include "partials/social.html" %}
{% endif %} {% endif %}