Skip to content

Commit dd50d5c

Browse files
committed
📝docs: 更新README内容并添加新功能描述
- 更新项目描述和功能特点,增加游戏内容和壁纸推荐 - 添加看板娘角色展示和烟花特效说明 - 更新依赖版本和技术栈信息 - 调整项目结构描述和部署配置
1 parent 99647d4 commit dd50d5c

1 file changed

Lines changed: 33 additions & 26 deletions

File tree

README.md

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,20 @@
1010
![VitePress](https://img.shields.io/badge/VitePress-1.6.3-brightgreen?style=flat-square&logo=vite)
1111
![Vue](https://img.shields.io/badge/Vue-3.0+-brightgreen?style=flat-square&logo=vue.js)
1212
![Node](https://img.shields.io/badge/Node-22.16.0-brightgreen?style=flat-square&logo=node.js)
13-
![pnpm](https://img.shields.io/badge/pnpm-10.12.3-blue?style=flat-square&logo=pnpm)
13+
![pnpm](https://img.shields.io/badge/pnpm-10.15.1-blue?style=flat-square&logo=pnpm)
1414

1515
[![Security Status](https://www.murphysec.com/platform3/v31/badge/1940988725560365056.svg)](https://www.murphysec.com/console/report/1940988725426147328/1940988725560365056)
1616

17-
这是一个基于 [VitePress](https://vitepress.dev/) 构建的个人网站,主要用于分享情感故事和个人创作
17+
这是一个基于 [VitePress](https://vitepress.dev/) 构建的个人网站,主要分享游戏相关内容、壁纸推荐、技术笔记和情感故事
1818
</div>
1919

2020
## 功能特点
2121

2222
- 简洁优雅的界面设计
23-
- 支持情感故事内容展示
23+
- 壁纸推荐展示(含动态壁纸)
24+
- 游戏新闻和赛事报道
25+
- 编程技术笔记(Vue等)
26+
- 情感故事分享
2427
- Algolia 搜索功能
2528
- 响应式设计,适配各种设备
2629
- 自动生成侧边栏导航
@@ -32,12 +35,14 @@
3235
- 图片缩放预览
3336
- 文章阅读时间和字数统计
3437
- 进度条加载效果
38+
- 看板娘角色展示
39+
- 烟花特效和动画效果
3540

3641
## 本地开发
3742

3843
### 环境要求
3944

40-
- Node.js 16.0 或更高版本 (当前使用 22.16.0)
45+
- Node.js 18.0 或更高版本 (当前使用 22.16.0)
4146
- pnpm(推荐)或 npm
4247

4348
### 安装依赖
@@ -67,43 +72,45 @@ pnpm docs:preview
6772
## 项目结构
6873

6974
```bash
70-
├── docs/ # 文档目录
71-
│ ├── .vitepress/ # VitePress 配置目录
72-
│ │ ├── config.mjs # VitePress 配置文件
73-
│ │ ├── configs/ # 配置模块目录
74-
│ │ ├── theme/ # 主题自定义目录
75-
│ │ │ ├── index.ts # 主题入口文件
76-
│ │ │ ├── components/ # 自定义组件目录
77-
│ │ │ └── style/ # 样式目录
78-
│ │ ├── cache/ # 缓存目录
79-
│ │ └── dist/ # 构建输出目录
80-
│ ├── public/ # 静态资源目录
81-
│ │ ├── images/ # 图片资源
82-
│ │ └── *.png # 其他静态资源
83-
│ ├── 文档/ # 文档内容目录
84-
│ ├── 策略/ # 策略内容目录
85-
│ └── *.md # Markdown 内容文件
86-
├── package.json # 项目依赖和脚本
87-
├── pnpm-lock.yaml # pnpm 依赖锁定文件
88-
└── LICENSE # 许可证文件
75+
├── docs/ # 文档目录
76+
│ ├── .vitepress/ # VitePress 配置目录
77+
│ │ ├── config.mjs # VitePress 配置文件
78+
│ │ ├── configs/ # 配置模块目录
79+
│ │ ├── theme/ # 主题自定义目录
80+
│ │ │ ├── index.ts # 主题入口文件
81+
│ │ │ ├── components/ # 自定义组件目录
82+
│ │ │ └── style.css # 样式文件
83+
│ │ ├── cache/ # 缓存目录
84+
│ │ └── dist/ # 构建输出目录
85+
│ ├── public/ # 静态资源目录
86+
│ │ └── images/ # 图片资源
87+
│ ├── 壁纸推荐/ # 壁纸推荐内容目录
88+
│ ├── 游戏新闻/ # 游戏新闻内容目录
89+
│ ├── 策略/ # 策略内容目录
90+
│ ├── 编程/ # 编程技术笔记目录
91+
│ └── *.md # Markdown 内容文件
92+
├── package.json # 项目依赖和脚本
93+
├── pnpm-lock.yaml # pnpm 依赖锁定文件
94+
└── LICENSE # 许可证文件
8995
```
9096

9197
## 技术栈
9298

9399
- [VitePress](https://vitepress.dev/) v1.6.3 - 静态网站生成器
94-
- [vitepress-sidebar](https://www.npmjs.com/package/vitepress-sidebar) v1.32.1 - 自动生成侧边栏
100+
- [vitepress-sidebar](https://www.npmjs.com/package/vitepress-sidebar) v1.33.0 - 自动生成侧边栏
95101
- [markdown-it-mathjax3](https://www.npmjs.com/package/markdown-it-mathjax3) v4.3.2 - 数学公式支持
96102
- [markdown-it-footnote](https://www.npmjs.com/package/markdown-it-footnote) v4.0.0 - 脚注功能
97103
- [vitepress-plugin-group-icons](https://www.npmjs.com/package/vitepress-plugin-group-icons) v1.6.1 - 代码组图标
98104
- [@mdit/plugin-figure](https://www.npmjs.com/package/@mdit/plugin-figure) v0.22.1 - 图片标题支持
99105
- [medium-zoom](https://www.npmjs.com/package/medium-zoom) v1.1.0 - 图片缩放
100106
- [nprogress-v2](https://www.npmjs.com/package/nprogress-v2) v1.1.10 - 进度条
101107
- [canvas-confetti](https://www.npmjs.com/package/canvas-confetti) v1.9.3 - 烟花特效
102-
- [@theojs/lumen](https://www.npmjs.com/package/@theojs/lumen) v6.0.0 - 文章元数据
108+
- [@theojs/lumen](https://www.npmjs.com/package/@theojs/lumen) v6.3.1 - 文章元数据
109+
- [oh-my-live2d](https://www.npmjs.com/package/oh-my-live2d) v0.19.3 - 看板娘展示
103110

104111
## 部署
105112

106-
本项目配置了 GitHub Pages 部署,基础路径设置为 `/vitepress`
113+
本项目配置了 GitHub Pages 部署,基础路径设置为 `/vitepress/`
107114
可以部署到任何静态网站托管服务,如 GitHub Pages、Netlify、Vercel 等。
108115

109116
## 许可证

0 commit comments

Comments
 (0)