# 技术文档积累

**Repository Path**: creepzzart/docs

## Basic Information

- **Project Name**: 技术文档积累
- **Description**: 技术文档积累
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-06
- **Last Updated**: 2026-02-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目文档中心

> 基于 **VitePress** 构建的个人/团队文档平台，用于系统化沉淀技术学习、项目资料与工作总结，兼顾**可读性、可维护性与扩展性**。

---

## 一、项目简介

本项目是一个基于 [VitePress](https://vitepress.vuejs.org/) 构建的文档站点，旨在为 **技术文档、学习笔记、项目资料与工作总结** 提供一个结构清晰、易维护、可持续演进的展示平台。

适用场景：

* 个人技术沉淀
* 团队项目文档
* 内部知识库
* 学习记录与复盘总结

---

## 二、站点整体结构

站点按“**内容类型 + 使用场景**”进行拆分，结构清晰、层级稳定：

### 1. 首页（`/`）

* 站点总览入口
* 项目介绍、模块导航、快速入口
* 可作为**官网式首页**或**文档导航页**使用

---

### 2. 技术文档（`/collections/`）

> 用于系统整理各类技术知识点，按方向分类归档。

* **前端**：HTML / CSS / JavaScript / Vue / React 等
* **后端**：Java / Spring / Node.js 等
* **数据库**：MySQL / Redis / PostgreSQL 等
* **运维**：Linux / Docker / CI/CD 等

特点：

* 以“知识点”为核心
* 适合长期积累
* 方便检索与复用

---

### 3. 项目文档（`/project-docs/`）

> 用于记录项目全生命周期相关资料。

包含内容：

* 需求说明
* 方案设计
* 架构设计
* 开发说明
* 接口文档
* 部署说明

适用场景：

* 个人项目复盘
* 团队协作沉淀
* 项目交接文档

---

### 4. 运维相关文档（`/ops/`）

> 专门用于沉淀服务器、部署、环境相关知识。

目录示例：

* `linux.md`：Linux 常用命令与实践总结
* `nginx.md`：Nginx 配置、反向代理、负载均衡等

可扩展：

* Docker
* K8s
* 安全加固
* 日志与监控

---

### 5. VitePress 学习与实验（`/vitepress-study/`）

> 用于研究 VitePress 本身能力、布局与扩展方式。

包含页面：

* `doc-demo.md`：默认文档布局示例
* `html-css.md`：HTML + CSS 实验页面
* `login-md.md`：自定义页面布局（登录页示例）
* `page-demo.md`：通用页面布局展示

用途：

* 探索布局能力
* 验证组件方案
* 作为模板沉淀

---

### 6. 工作总结（`/work-summary/`）

> 用于记录阶段性工作内容与个人成长。

可按：

* 周报
* 月报
* 项目总结
* 年度总结

进行分类归档，方便复盘与回顾。

---

## 三、技术栈

* **框架**：VitePress
* **语言**：Markdown + Vue
* **构建工具**：Vite
* **部署方式**：静态资源部署（Gitee Pages / GitHub Pages / Nginx / OSS 等）

---

## 四、本地运行

```bash
# 安装依赖
npm install

# 启动开发服务器
npm run docs:dev
```

访问：`http://localhost:5173`

---

## 五、构建与部署

### 构建静态资源

```bash
npm run docs:build
```

输出目录：

```
docs/.vitepress/dist/
```

---

### 部署建议

#### 1. Gitee Pages / GitHub Pages

1. 修改 `docs/.vitepress/config.ts` 中的 `base`
2. 推送代码到仓库
3. 开启 Pages 服务并指定构建目录

#### 2. Nginx 部署

```nginx
server {
  listen 80;
  server_name your.domain.com;

  root /var/www/docs;
  index index.html;

  location / {
    try_files $uri $uri/ /index.html;
  }
}
```

---

## 六、目录结构说明

```
docs/
├── .vitepress/            # VitePress 配置
├── collections/           # 技术文档
├── ops/                   # 运维相关文档
├── project-docs/          # 项目文档
├── vitepress-study/       # VitePress 学习与实验
├── work-summary/          # 工作总结
├── index.md               # 首页
└── package.json           # 项目配置
```

---

## 七、文档规范

* 统一使用 Markdown 编写
* 标题层级清晰（## / ### / ####）
* 一页一主题，避免大杂烩
* 代码块注明语言
* 重要结论加粗

---

## 八、贡献与维护

* 提交 Issue：问题反馈、建议
* 提交 PR：内容补充、结构优化
* 鼓励持续维护与演进

---

## 九、License

本项目采用 **MIT License**。

---

## 十、联系

如有问题或建议，请通过仓库 Issue 联系，或发送邮件至：

📧 [creepzzart@gitee.com](mailto:creepzzart@gitee.com)