docs(readme): 重构 README 文件内容和结构
- 删除英文 README 完整内容,保留简洁中文版本 - 增加博客介绍与主要内容板块,更加清晰明了 - 添加技术栈说明,涵盖框架、主题、构建工具和语言 - 详细编写快速开始指南,包含安装依赖、本地开发和构建生产版本步骤 - 新增清除缓存开发命令说明 - 补充项目目录结构说明,方便读者理解文件布局 - 引入 MIT 许可证声明,提高项目开源合规性
This commit is contained in:
36
README.en.md
36
README.en.md
@@ -1,36 +0,0 @@
|
||||
# 博客
|
||||
|
||||
#### Description
|
||||
一个专注于分享编程知识、技术趋势和开发经验的开源博客,旨在帮助开发者提升技能,促进技术交流与学习。
|
||||
|
||||
#### Software Architecture
|
||||
Software architecture description
|
||||
|
||||
#### Installation
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Instructions
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Contribution
|
||||
|
||||
1. Fork the repository
|
||||
2. Create Feat_xxx branch
|
||||
3. Commit your code
|
||||
4. Create Pull Request
|
||||
|
||||
|
||||
#### Gitee Feature
|
||||
|
||||
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
|
||||
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
|
||||
4. The most valuable open source project [GVP](https://gitee.com/gvp)
|
||||
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
|
||||
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||||
89
README.md
89
README.md
@@ -1,37 +1,76 @@
|
||||
# 博客
|
||||
# 氓氓的个人博客
|
||||
|
||||
#### 介绍
|
||||
一个专注于分享编程知识、技术趋势和开发经验的开源博客,旨在帮助开发者提升技能,促进技术交流与学习。
|
||||
## 📝 介绍
|
||||
|
||||
#### 软件架构
|
||||
软件架构说明
|
||||
一个专注于分享编程知识、技术趋势和开发经验的个人博客,记录学习成长的点点滴滴。
|
||||
|
||||
主要内容包括:
|
||||
- 💻 编程技术(Go、Java、前端等)
|
||||
- 🐧 Linux 系统使用与配置
|
||||
- 🛠️ 实用工具分享
|
||||
- 📱 应用部署与配置(Jellyfin、RustDesk 等)
|
||||
- 📚 工作日志与技术总结
|
||||
|
||||
#### 安装教程
|
||||
## 🏗️ 技术栈
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
- **框架**: [VuePress v2](https://v2.vuepress.vuejs.org/zh/)
|
||||
- **主题**: [VuePress Theme Hope](https://theme-hope.vuejs.press/zh/)
|
||||
- **构建工具**: Vite
|
||||
- **语言**: TypeScript + Vue 3
|
||||
|
||||
#### 使用说明
|
||||
## 🚀 快速开始
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
### 安装依赖
|
||||
|
||||
#### 参与贡献
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 新建 Feat_xxx 分支
|
||||
3. 提交代码
|
||||
4. 新建 Pull Request
|
||||
### 本地开发
|
||||
|
||||
```bash
|
||||
npm run docs:dev
|
||||
```
|
||||
|
||||
#### 特技
|
||||
访问 `http://localhost:8080` 即可预览博客
|
||||
|
||||
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
|
||||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
|
||||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
|
||||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
||||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
||||
### 构建生产版本
|
||||
|
||||
```bash
|
||||
npm run docs:build
|
||||
```
|
||||
|
||||
构建产物将生成在 `src/.vuepress/dist` 目录
|
||||
|
||||
### 清除缓存开发
|
||||
|
||||
```bash
|
||||
npm run docs:clean-dev
|
||||
```
|
||||
|
||||
## 📂 目录结构
|
||||
|
||||
```
|
||||
.
|
||||
├── src/
|
||||
│ ├── .vuepress/ # VuePress 配置
|
||||
│ │ ├── config.ts # 站点配置
|
||||
│ │ ├── theme.ts # 主题配置
|
||||
│ │ ├── navbar.ts # 导航栏配置
|
||||
│ │ ├── sidebar.ts # 侧边栏配置
|
||||
│ │ └── styles/ # 自定义样式
|
||||
│ ├── programming/ # 编程相关文章
|
||||
│ │ ├── backend/ # 后端(Go、Java)
|
||||
│ │ ├── frontend/ # 前端
|
||||
│ │ ├── linux/ # Linux
|
||||
│ │ └── docker/ # Docker
|
||||
│ ├── apps/ # 应用部署
|
||||
│ ├── tools/ # 工具分享
|
||||
│ ├── work/ # 工作日志
|
||||
│ └── README.md # 首页
|
||||
└── package.json
|
||||
```
|
||||
|
||||
## 📄 License
|
||||
|
||||
MIT License
|
||||
|
||||
Reference in New Issue
Block a user