From cf0b2c3db5590753f5ca4952081cf0d522a6baa1 Mon Sep 17 00:00:00 2001 From: Wcowin <1135801806@qq.com> Date: Wed, 19 Feb 2025 11:04:06 +0800 Subject: [PATCH] 25/2/19 --- README.md | 1 + docs/blog/Mkdocs/mkdocs1.md | 32 ++++++++++++++++++++------------ docs/blog/Mkdocs/mkdocs3.md | 2 +- docs/blog/posts/update2025.md | 3 +++ docs/index.md | 16 ++++++++++++++-- mkdocs.yml | 10 +++++----- 6 files changed, 44 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 5ba5d06..8b151af 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,7 @@ [![Star History Chart](https://api.star-history.com/svg?repos=Wcowin/Mkdocs-Wcowin&type=Date)](https://star-history.com/#Wcowin/Mkdocs-Wcowin&Date) +![Alt](https://repobeats.axiom.co/api/embed/b824e1bf28f31c9fa190eb5079cc1d035e562e0b.svg "Repobeats analytics image") ## 贡献者 diff --git a/docs/blog/Mkdocs/mkdocs1.md b/docs/blog/Mkdocs/mkdocs1.md index a2870fe..0c2a2b1 100644 --- a/docs/blog/Mkdocs/mkdocs1.md +++ b/docs/blog/Mkdocs/mkdocs1.md @@ -1,5 +1,5 @@ --- -title: 利用Mkdocs部署个人静态博客网页至GitHubpages +title: 利用Mkdocs部署静态网页至GitHubpages tags: - Mkdocs --- @@ -50,9 +50,14 @@ mkdocs new mkdocs-site 出现下图的几个文件 ![img](https://s1.imagehub.cc/images/2024/02/02/140869d445e8c6dfd026e71e3ff0fc09.png) -docs文件下是以后网站的内容，mkdocs.yml是配置文件（配置主题，目录，插件等） +!!! tip - 你在这个目录下写的任何东西都可以通过github Desktop 上传到github上 + 这里建议把**mkdocs-site**文件里的东西全部剪切出来到**Wcowin.github.io**文件里 + ![img](https://s1.imagehub.cc/images/2024/02/02/b4a5ac989f1f390573a85bad8c80f49b.png) + +**Wcowin.github.io**是克隆到本地的仓库（里面包含docs,yml文件等等），docs文件下是以后网站的内容，mkdocs.yml是配置文件（配置主题，目录，插件等） + +你在这个目录下写的任何东西都可以通过Github Desktop 上传到github上 执行下面的代码添加一个GitHub Workflow *** @@ -101,7 +106,8 @@ cd workflows vim ci.yml ``` -.github/workflows/ci.yml，然后复制并粘贴以下内容： +进入.github/workflows/ci.yml，然后复制并粘贴以下内容： + ```yaml name: ci on: @@ -134,10 +140,12 @@ jobs: - run: mkdocs gh-deploy --force ``` + +到这里先检查一下你的目录结构 目录树状图: ``` $ tree -a -. +Wcowin.github.io ├── .github │ ├── .DS_Store │ └── workflows @@ -149,13 +157,10 @@ $ tree -a !!!重点来了 -仓库setings/Actions/General 勾选这两项 +Github仓库setings/Actions/General 勾选这两项 ![](https://s1.imagehub.cc/images/2024/02/02/02fd4e77eb52d4ce18c227f0e29b2c6d.png) ## 三、配置完善 -打开终端运行 - -`pip install mkdocs-material` 打开**mkdocs.yml** @@ -185,6 +190,8 @@ mkdocs serve 最后去github Desktop上传到github ![img](https://s1.imagehub.cc/images/2024/02/02/3a15b16d3947825f3f469b4eafedd5ef.png) +上图可以看到，我上传了Wcowin.github.io文件夹，这个文件夹里面包含了mkdocs.yml和docs文件夹(mkdocs-site文件夹现在没有东西，可以删除) + **！！！重点** **去仓库的setings/pages选择下图示意的路径** @@ -202,12 +209,13 @@ https://你github的名字.github.io/ 下次谈谈网站的[mkdocs.yml具体配置](mkdocs2.md) -[^注]:于2023.3.24重写此文 - ## 四、参考资料 1. [MkDocs官网](https://www.mkdocs.org/) 2. [MkDocs中文文档](https://hellowac.github.io/mkdocs-docs-zh/) 3. [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) 4. [Mkdocs 配置和使用](https://zhuanlan.zhihu.com/p/383582472) -5. [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs) \ No newline at end of file +5. [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs) + + +[^注]:于2025.2.19重写此文 \ No newline at end of file diff --git a/docs/blog/Mkdocs/mkdocs3.md b/docs/blog/Mkdocs/mkdocs3.md index e66f93d..9d1a796 100644 --- a/docs/blog/Mkdocs/mkdocs3.md +++ b/docs/blog/Mkdocs/mkdocs3.md @@ -1,5 +1,5 @@ --- -title: 解决 mkdocs部署 Github Pages 自定义域名失效的问题 +title: 解决Github Pages部署mkdocs自定义域名失效的问题 tags: - Mkdocs --- diff --git a/docs/blog/posts/update2025.md b/docs/blog/posts/update2025.md index 5599db7..4240dba 100644 --- a/docs/blog/posts/update2025.md +++ b/docs/blog/posts/update2025.md @@ -6,6 +6,9 @@ categories: - 网站更新记录 readtime: 2 --- +##

2025-02-19

+* 优化网站流畅度（玄学） +* 更新了MKdocs教程，适应官方最新版本 ##

2025-02-16

* [首页](../../index.md)焕然一新 diff --git a/docs/index.md b/docs/index.md index 1d60265..fc574d1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,8 +16,20 @@ ____ __ ____ ______ ______ ____ __ ____ __ .__ __. \__/ \__/ \______| \______/ \__/ \__/ |__| |__| \__| --> -

Wcowin for MkDocs博客主题
- + +
Wcowin for MkDocs博客教程
+ +