# Wcowin for MkDocs主题

**- 基于Material for MkDocs美化**  
**- 简洁美观，功能多元化**  
**- 可自定义样式，中文教程详细**  
**- 简单易上手，小白配置**  
**- 𝕙𝕒𝕧𝕖 𝕒 𝕘𝕠𝕠𝕕 𝕥𝕚𝕞𝕖 !**



## 展示  

<center>

**主页**
![](https://pic4.zhimg.com/80/v2-b74491257518429555b9f58a3bdc1293_1440w.webp)   

**文章页**
![](https://s1.imagehub.cc/images/2024/02/02/c15305494c69f311a721c0878b648b22.png)  

**博客页**
![](https://pic1.zhimg.com/80/v2-652abf2464779ebc6e5790ecaccaadde_1440w.webp) 

**关于**
<img width="1355" alt="image" src="https://github.com/Wcowin/Mkdocs-Wcowin/assets/99159173/bfc10737-260c-44c7-b036-8c7dba52be24">


**标签页**
![img](https://s1.imagehub.cc/images/2024/02/02/d20f0562838a8396724f18bfd09e19e8.png)  

**简洁的友链页面**
![](https://pic2.zhimg.com/80/v2-551c0a6e858705f842e2984fd44ce7f7_1440w.webp)

**页面底部**
<img width="1363" alt="image" src="https://github.com/Wcowin/Mkdocs-Wcowin/assets/99159173/ac4db87b-396a-4d0e-99b5-51a1b316db33">

**Lighthouse测试结果**
<img width="1363" alt="image" src="https://pic3.zhimg.com/80/v2-afef47cac915ad51071fdc2f6d990b30_1440w.webp">

<img width="1363" alt="image" src="https://s2.loli.net/2025/02/13/M7dgcDiGOI28PQs.png">

</center>

## 如何快速使用  

打开终端安装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`即可
![image.png](https://s2.loli.net/2025/01/02/nsDEbN5OPk3atcp.png)

> 另一种运行方法：根目录有一个`Mkdocs-serve.bat`批处理文件，直接双击即可

详细的初步教程见：[利用Mkdocs部署静态网页至GitHubpages](TECH.md)

## 视频教程

[Mkdocs中文教程视频](https://space.bilibili.com/1407028951/lists/4566631?type=series)

# Connect with me

<center>

**Wechat**  
  <a href="https://pic3.zhimg.com/80/v2-5ef3dde831c9d0a41fe35fabb0cb8784_1440w.webp" target="_blank">
   <center>
    <img src="https://pic3.zhimg.com/80/v2-5ef3dde831c9d0a41fe35fabb0cb8784_1440w.webp" style="width: 450px; height: auto;">
    </center>  
  </a>  

**Telegram**

  <a href="https://t.me/wecowin" target="_blank" >
   <center>
    <img src="https://pica.zhimg.com/80/v2-d5876bc0c8c756ecbba8ff410ed29c14_1440w.webp" style="width: 450px; height: auto;">
    </center>  
  </a>

</center>

## 案例成果

[Lenny's Web](https://lennychen.top)  
[苍镜月's docs](https://pale-illusions.github.io/my-mkdocs/)  
[世界天光的笔记本](https://lastwish.icu/)  
[Wen-Chieh Lee的生活](https://wenchiehlee.github.io/mkdocs-life/)
[BruceJin's Notebook](https://brucejqs.github.io/MyNotebook/)  
[0X10CC的代码空间](https://tang-jiapeng.github.io/)  
[GENG Wei's Homepage](https://wgeng.site/index.html)

谢谢你们~

## Star History

[![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")

## 贡献者
<a href="https://github.com/Wcowin/Mkdocs-Wcowin/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=Wcowin/Mkdocs-Wcowin" />
</a>

[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

## 版权声明

本作品采用[知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh-hans)进行许可。