Skip to content

Commit 5b26bf7

Browse files
committed
Update README.md
1 parent 276961d commit 5b26bf7

File tree

1 file changed

+54
-18
lines changed

1 file changed

+54
-18
lines changed

README.md

Lines changed: 54 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
**技术图谱** 是一个面向Java工程师的学习资源库,旨在帮助开发者系统地学习和掌握Java技术栈的核心知识,从Java语言基础到高级框架与中间件,再到分布式系统和云原生技术,构建完整的技术知识体系。
1111

12-
本项目采用VitePress构建,提供了清晰的目录结构和丰富的学习资源,帮助开发者在技术成长道路上少走弯路,实现高效进阶。
12+
本项目采用VitePress 1.6.4构建,提供了清晰的目录结构、丰富的学习资源和高效的搜索功能,帮助开发者在技术成长道路上少走弯路,实现高效进阶。
1313

1414
## ✨ 项目特点
1515

@@ -18,46 +18,62 @@
1818
- **实用导向**:结合实际应用场景,注重技术的实际落地和最佳实践
1919
- **持续更新**:跟踪技术发展趋势,及时更新内容,保持技术的前沿性
2020
- **易于导航**:清晰的目录结构和导航设计,方便快速定位所需内容
21+
- **高效搜索**:集成本地搜索功能,支持内容快速检索,提高学习效率
22+
- **现代界面**:采用现代化的UI设计,提供良好的阅读体验
2123

2224
## 📁 目录结构
2325

2426
项目采用模块化的目录结构,主要内容位于`docs/guide/`目录下,按技术领域划分为多个子目录和文件:
2527

2628
```
2729
docs/
30+
├── .vitepress/ # VitePress配置目录
31+
│ ├── config.js # 主配置文件
32+
│ └── style.css # 自定义样式文件
2833
├── guide/ # 主要内容目录
2934
│ ├── java-core/ # Java语言核心
3035
│ │ ├── core.md # Java核心基础知识
3136
│ │ ├── java-new-features/ # Java各版本新特性
3237
│ │ ├── jvm.md # JVM相关知识
33-
│ │ └── concurrency-programming/ # 并发编程
38+
│ │ ├── concurrency-programming/ # 并发编程
39+
│ │ ├── java-rmi.md # Java RMI
40+
│ │ └── java-spi.md # Java SPI
3441
│ ├── framework-and-middleware/ # 框架与中间件
35-
│ │ ├── dubbo/ # Dubbo框架
36-
│ │ ├── elasticsearch/ # Elasticsearch
37-
│ │ ├── kafka/ # Kafka
38-
│ │ ├── redis/ # Redis
42+
│ │ ├── mysql/ # MySQL数据库
43+
│ │ ├── redis/ # Redis缓存
44+
│ │ ├── kafka/ # Kafka消息队列
3945
│ │ └── ... # 其他框架与中间件
4046
│ ├── containerization-and-cloud-native/ # 容器化与云原生
4147
│ ├── distributed-system/ # 分布式系统
42-
│ ├── system-security.md # 系统安全
43-
│ ├── performance.md # 性能工程
44-
│ ├── practice.md # 工程实践
45-
│ ├── new-tech.md # 新兴技术
46-
│ └── soft.md # 软技能
48+
│ ├── microservices-and-api-design/ # 微服务与API设计
49+
│ ├── architecture-design/ # 架构设计
50+
│ ├── system-security/ # 系统安全
51+
│ ├── performance/ # 性能优化
52+
│ ├── test-and-quality/ # 测试与质量保障
53+
│ ├── development-tools/ # 开发工具
54+
│ ├── practice/ # 工程实践
55+
│ ├── new-tech/ # 新兴技术
56+
│ ├── soft/ # 软技能
57+
│ └── java-language-overview.md # Java语言概述
4758
├── index.md # 首页
48-
└── .vitepress/ # VitePress配置
59+
└── public/ # 静态资源文件
60+
├── favicon.ico # 网站图标
61+
├── technical-graph-doc.jpg # 项目Logo
62+
└── ... # 其他静态资源
4963
```
5064

5165
## 🚀 快速开始
5266

5367
### 环境要求
54-
- Node.js >= 10.16
55-
- npm >= 6.9
68+
- Node.js >= 16.0
69+
- npm >= 7.0
5670

5771
### 安装依赖
5872

73+
由于项目依赖可能存在版本兼容性问题,建议使用`--legacy-peer-deps`选项安装:
74+
5975
```bash
60-
npm install
76+
npm install --legacy-peer-deps
6177
```
6278

6379
### 本地开发
@@ -66,7 +82,7 @@ npm install
6682
npm run docs:dev
6783
```
6884

69-
启动后可以通过浏览器访问 [http://localhost:5173/technical-graph-doc/](http://localhost:5173/technical-graph-doc/) 查看文档。
85+
启动后可以通过浏览器访问 [http://localhost:5173/technical-graph-doc/](http://localhost:5173/technical-graph-doc/) 查看文档。如果5173端口被占用,系统会自动尝试其他端口。
7086

7187
### 构建网站
7288

@@ -76,6 +92,16 @@ npm run docs:build
7692

7793
构建后的文件将生成在 `docs/.vitepress/dist` 目录下,可以部署到任何静态网站托管服务。
7894

95+
## 🔍 搜索功能使用
96+
97+
本项目集成了高效的本地搜索功能,帮助你快速查找所需内容:
98+
99+
1. 在网站顶部导航栏中点击搜索图标或使用快捷键
100+
2. 输入关键词进行搜索
101+
3. 搜索结果会实时显示,点击结果可直接跳转至对应内容
102+
103+
搜索功能支持模糊匹配和关键词高亮显示,优化了用户体验。
104+
79105
## 🤝 贡献指南
80106

81107
我们欢迎并鼓励社区贡献。如果你有任何建议、问题或想要添加新的内容,请按照以下步骤:
@@ -86,13 +112,23 @@ npm run docs:build
86112
4. 推送到分支 (`git push origin feature/AmazingFeature`)
87113
5. 打开一个 Pull Request
88114

115+
## 🚀 自动部署
116+
117+
本项目配置了GitHub Actions自动部署流程,当代码推送到主分支时,会自动构建并部署到GitHub Pages。部署配置位于 `.github/workflows/deploy-docs.yml` 文件中。
118+
119+
你也可以使用项目根目录下的部署脚本手动部署:
120+
121+
```bash
122+
./deploy-to-github-pages.sh
123+
```
124+
89125
## 📝 许可协议
90126

91-
本项目采用 [Apache License 2.0](LICENSE) 许可协议。
127+
本项目采用 [MIT License](LICENSE) 许可协议。
92128

93129
## 🔗 相关链接
94130

95-
- [在线文档](https://zhuyizhuo.github.io/technical-graph-doc/)
131+
- [在线文档](https://zhuyizhuo.github.io/technical-graph-doc/)
96132
- [GitHub 仓库](https://github.com/zhuyizhuo/technical-graph)
97133

98134
## 📧 联系我们

0 commit comments

Comments
 (0)