# projects-szf

**Repository Path**: windrunner1/projects-szf

## Basic Information

- **Project Name**: projects-szf
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-22
- **Last Updated**: 2025-12-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 知识库网站

一个基于 MkDocs + Material 主题构建的精美个人知识库，支持 Mermaid 图表渲染。

## 🌟 特性

- 🎨 **精美主题**: 基于 Material for MkDocs，支持深色/浅色模式
- 📊 **图表支持**: 集成 Mermaid 插件，支持流程图、时序图、类图等
- 🔍 **智能搜索**: 支持中文全文搜索
- 📱 **响应式设计**: 完美适配桌面和移动设备
- 🚀 **高性能**: 静态网站，加载速度快
- 🛠️ **易于维护**: 基于 Markdown，版本控制友好

## 📂 项目结构

```
mkdocs-site/
├── docs/                           # 文档目录
│   ├── index.md                    # 首页
│   ├── 技术笔记/                   # 技术相关内容
│   ├── 学习指南/                   # 学习资源
│   ├── 生活随笔/                   # 生活感悟
│   ├── Mermaid 图表/               # 图表示例
│   └── assets/                     # 静态资源
│       ├── stylesheets/            # CSS 文件
│       └── javascripts/            # JavaScript 文件
├── mkdocs.yml                      # MkDocs 配置文件
├── requirements.txt                # Python 依赖
├── README.md                       # 项目说明
└── site/                          # 构建输出目录（自动生成）
```

## 🚀 快速开始

### 环境要求

- Python 3.7+
- pip

### 本地开发

1. **克隆项目**
   ```bash
   git clone <repository-url>
   cd mkdocs-site
   ```

2. **安装依赖**
   ```bash
   pip install -r requirements.txt
   ```

3. **启动开发服务器**
   ```bash
   mkdocs serve
   ```

4. **访问网站**
   
   打开浏览器访问 http://127.0.0.1:8000

### 构建部署

1. **构建静态网站**
   ```bash
   mkdocs build
   ```

2. **部署到 GitHub Pages**
   ```bash
   mkdocs gh-deploy
   ```

## 📝 内容管理

### 添加新页面

1. 在 `docs/` 目录下创建 Markdown 文件
2. 在 `mkdocs.yml` 的 `nav` 部分添加导航配置

### 添加 Mermaid 图表

使用以下语法创建图表：

````markdown
```mermaid
graph TD
    A[开始] --> B[处理]
    B --> C[结束]
```
````

### 自定义样式

- 编辑 `docs/assets/stylesheets/extra.css`
- 添加自定义 CSS 规则

## ⚙️ 配置说明

### 主要配置项

- **theme**: Material 主题配置
- **plugins**: 插件配置（搜索、Mermaid 等）
- **markdown_extensions**: Markdown 扩展配置
- **nav**: 导航结构配置

### 主题定制

在 `mkdocs.yml` 中可以自定义：

- 颜色主题
- 字体设置
- 功能特性
- 图标配置

## 🛠️ 开发脚本

### 构建脚本
```bash
bash .cozeproj/scripts/deploy_build.sh
```

### 运行脚本
```bash
bash .cozeproj/scripts/deploy_run.sh
```

## 📊 支持的图表类型

| 类型 | 描述 | 语法示例 |
|------|------|----------|
| 流程图 | 业务流程可视化 | `graph TD` |
| 时序图 | 系统交互时序 | `sequenceDiagram` |
| 类图 | 类结构关系 | `classDiagram` |
| 状态图 | 状态转换 | `stateDiagram` |
| 甘特图 | 项目进度 | `gantt` |
| 饼图 | 数据占比 | `pie` |
| 思维导图 | 知识结构 | `mindmap` |

## 🌈 主题功能

- **深色/浅色模式**: 自动检测系统主题，支持手动切换
- **代码高亮**: 支持多种编程语言语法高亮
- **搜索功能**: 实时搜索，支持中文分词
- **导航增强**: 面包屑导航、目录生成
- **响应式**: 移动端适配，触屏优化

## 📚 学习资源

- [MkDocs 官方文档](https://www.mkdocs.org/)
- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
- [Mermaid 图表语法](https://mermaid.js.org/)
- [Markdown 语法指南](https://www.markdownguide.org/)

## 🤝 贡献指南

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 开启 Pull Request

## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。

## 📞 联系方式

如有问题或建议，请通过以下方式联系：

- 提交 Issue
- 发送邮件
- 讨论区交流

---

!!! quote "💡 提示
    
    > 好的知识库需要持续维护和更新，让知识的价值随时间增长。"