Mkdocs-Wcowin/README.md

# Mkdocs-Wcowin主题

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


## 展示
<center>

**主页**
![](https://s1.imagehub.cc/images/2024/02/02/357ba91e8e68c554ce015fd0c95a08d8.png)   

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

**博客页**
![](https://s1.imagehub.cc/images/2024/02/02/cee8d935a920668b738593850c7eb7f8.png) 

**关于**
<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://s1.imagehub.cc/images/2024/02/02/068cf12de3d9c44dbbd00f4f121e908e.png)

**页面底部**
<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://s2.loli.net/2025/01/02/VHeITXxJgwOKSsu.jpg">

</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)

# Connect with me

<center>

**Telegram**

<p align="center">
  <a href="https://s2.loli.net/2025/01/04/oUqPCHxTVRZJ41w.jpg" target="_blank">
    <img src="https://s2.loli.net/2025/01/04/oUqPCHxTVRZJ41w.jpg" alt="个人名片" style="border-radius: 10px;" width="50%">
  </a>
</p>


**Wechat**  
<!-- ![](https://s1.imagehub.cc/images/2024/02/02/bb9ee71b03ee7a3b87caad5cc4bcebff.jpeg) -->
<p align="center">
<img src="https://s1.imagehub.cc/images/2024/02/02/bb9ee71b03ee7a3b87caad5cc4bcebff.jpeg" style="border-radius: 10px;" width="50%">
</p>

</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)


## 贡献者
<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)进行许可。