Skip to content

Commit b591684

Browse files
SnailclimbSnailclimb
committed
[docs update]项目首页完善
1 parent d8b46f2 commit b591684

File tree

6 files changed

+109
-69
lines changed

6 files changed

+109
-69
lines changed

‎docs/.vuepress/config.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ module.exports = config({
9393
],
9494
sidebar: {
9595
// 应该把更精确的路径放置在前边
96+
"/javaguide/": [
97+
"intro", "contribution-guideline", "faq", "todo"
98+
],
9699
"/about-the-author/": [
97100
{
98101
title: "个人经历", icon: "zuozhe", collapsable: false,

‎docs/home.md‎

Lines changed: 9 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ icon: creative
33
title: JavaGuide（Java学习&&面试指南）
44
---
55

6-
<a href="https://t.1yb.co/GXLF"><img src="https://img-blog.csdnimg.cn/2f61f3e2d1f2427da977340919e41616.png" style="margin: 0 auto;width:850px" /></a>
7-
86
<div align="center">
97
<p>
108
<a href="https://github.com/Snailclimb/JavaGuide" target="_blank">
@@ -24,37 +22,19 @@ title: JavaGuide（Java学习&&面试指南）
2422
</p>
2523
</div>
2624

27-
> 1. **贡献指南** ：欢迎参与 [JavaGuide 的维护工作](https://zhuanlan.zhihu.com/p/464832264)，这是一件非常有意义的事情。
28-
> 2. **面试专版** ：准备面试的小伙伴可以考虑面试专版：[《Java 面试进阶指北 》](https://www.yuque.com/docs/share/f37fc804-bfe6-4b0d-b373-9c462188fec7) (质量很高，专为面试打造，配合 JavaGuide 食用)
29-
> 3. **转载须知** ：以下所有文章如非文首说明为转载皆为我（Guide 哥）的原创，转载在文首注明出处，如发现恶意抄袭/搬运，会动用法律武器维护自己的权益。让我们一起维护一个良好的技术创作环境！⛽️
30-
31-
在大三准备面试的时候，我开源了 JavaGuide 。我把自己准备面试过程中的一些总结都毫不保留地通过 JavaGuide 分享了出来。
32-
33-
开源 JavaGuide 初始想法源于自己的个人那一段比较迷茫的学习经历。主要目的是为了通过这个开源平台来帮助一些在学习 Java 或者面试过程中遇到问题的小伙伴。
34-
35-
- **对于 Java 初学者来说：** 本文档倾向于给你提供一个比较详细的学习路径，让你对于 Java 整体的知识体系有一个初步认识。另外，本文的一些文章也是你学习和复习 Java 知识不错的实践；
36-
- **对于非 Java 初学者来说：** 本文档更适合回顾知识，准备面试，搞清面试应该把重心放在那些问题上。要搞清楚这个道理：提前知道那些面试常见，不是为了背下来应付面试，而是为了让你可以更有针对的学习重点。
37-
38-
相比于其他通过 JavaGuide 学到东西或者说助力获得 offer 的朋友来说 ， JavaGuide 对我的意义更加重大。不夸张的说，有时候真的感觉像是自己的孩子一点一点长大一样，我一直用心呵护着它。虽然，我花了很长时间来维护它，但是，我觉得非常值得！非常有意义！
39-
40-
希望大家对面试不要抱有侥幸的心理，打铁还需自身硬！ 我希望这个文档是为你学习 Java 指明方向，而不是用来应付面试用的。加油！奥利给！
25+
> 1. **面试专版** ：准备面试的小伙伴可以考虑面试专版：[《Java 面试进阶指北 》](https://www.yuque.com/docs/share/f37fc804-bfe6-4b0d-b373-9c462188fec7) (质量很高，专为面试打造，配合 JavaGuide 食用)
26+
> 2. **转载须知** ：以下所有文章如非文首说明为转载皆为我（Guide 哥）的原创，转载在文首注明出处，如发现恶意抄袭/搬运，会动用法律武器维护自己的权益。让我们一起维护一个良好的技术创作环境！⛽️
4127
42-
## 项目说明
28+
你可能需要：
4329

44-
- 项目的 Markdown 格式参考：[Github Markdown 格式](https://guides.github.com/features/mastering-markdown/)，表情素材来自：[EMOJI CHEAT SHEET](https://www.webpagefx.com/tools/emoji-cheat-sheet/)。
45-
- Logo 下的小图标是使用[Shields.IO](https://shields.io/) 生成的。
30+
- [项目介绍](/javaguide/intro)
31+
- [贡献指南](/javaguide/contribution-guideline)
32+
- [常见问题](/javaguide/faq)
33+
- [项目代办](/javaguide/todo)
4634

47-
## 贡献者
35+
## 面试资源
4836

49-
[你可以点此链接查看 JavaGuide 的所有贡献者。](https://github.com/Snailclimb/JavaGuide/graphs/contributors) 感谢你们让 JavaGuide 变得更好！如果你们来到武汉一定要找我，我请你们吃饭玩耍。
50-
51-
欢迎参与 [JavaGuide 的维护工作](https://zhuanlan.zhihu.com/p/464832264)，这是一件非常有意义的事情。
52-
53-
## 待办
54-
55-
- [ ] JVM 部分内容更新完善
56-
- [ ] 计算机网络知识点完善
57-
- [ ] 分布式常见理论和算法总结完善
37+
<a href="https://t.1yb.co/GXLF"><img src="https://img-blog.csdnimg.cn/2f61f3e2d1f2427da977340919e41616.png" style="margin: 0 auto;width:850px" /></a>
5838

5939
## 联系我
6040

@@ -70,43 +50,3 @@ title: JavaGuide（Java学习&&面试指南）
7050

7151
![我的公众号](https://cdn.jsdelivr.net/gh/javaguide-tech/blog-images/2020-08/167598cd2e17b8ec.png)
7252

73-
## 常见问题
74-
75-
### 如何对该开源文档进行贡献？
76-
77-
欢迎参与 JavaGuide 的维护工作，这是一件非常有意义的事情。详细信息请看：[JavaGuide 贡献指南](https://zhuanlan.zhihu.com/p/464832264) 。
78-
79-
你可以从下面几个方向来做贡献：
80-
81-
- 笔记内容大多是手敲，所以难免会有笔误，你可以帮我找错别字。
82-
- 很多知识点我可能没有涉及到，所以你可以对其他知识点进行补充。
83-
- 现有的知识点难免存在不完善或者错误，所以你可以对已有知识点进行修改/补充。
84-
85-
如果要提 issue/question 的话，强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/~sgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)。
86-
87-
### 如何看待 JavaGuide 的 star 数量很多？
88-
89-
[JavaGuide](https://github.com/Snailclimb) 目前已经是 Java 领域 star 数量最多的几个项目之一，登顶过很多次 Github Trending。
90-
91-
不过，这个真心没啥好嘚瑟的。因为，教程类的含金量其实是比较低的，star 数量比较多主要也是因为受众面比较广，大家觉得不错，点个 star 就相当于收藏了。很多特别优秀的框架，star 数量可能只有几 K。所以，单纯看 star 数量没啥意思，就当看个笑话吧！
92-
93-
维护这个项目的过程中，也被某些人 diss 过：“md 项目，没啥含金量，给国人丢脸！”。
94-
95-
对于说这类话的人，我觉得对我没啥影响，就持续完善，把 JavaGuide 做的更好吧！其实，国外的很多项目也是纯 MD 啊！就比如外国的朋友发起的 awesome 系列、求职面试系列。无需多说，行动自证！凎！
96-
97-
开源非常重要的一点就是协作。如果你开源了一个项目之后，就不再维护，别人给你提交 issue/pr，你都不处理，那开源也没啥意义了！
98-
99-
### JavaGuide 会不会推出纸质书籍？
100-
101-
可以给出一个比较明确的答案：**暂时没有考虑出书** 。
102-
103-
JavaGuide 这个项目诞生一年左右就有出版社的老师联系我了，由于自知个人能力尚需沉淀，我都婉拒了。这几年的话，由于项目还是有一点知名度的，找我出书的出版社老师更多了，也都被我一一婉拒了。
104-
105-
**出书既能博名又能赚点钱，我为啥不考虑出书呢？**
106-
107-
1. JavaGuide 的很多内容我还不是很满意，也一直在维护中，细心的小伙伴看我的提交记录就明白了。
108-
2. 开源版本更容易维护和修改，也能让更多人更方便地参与到项目的建设中，这也是我最初做这个项目的初衷。
109-
3. 我觉得出书是一件神圣的事情，自认能力还不够。
110-
4. 个人精力有限，不光有本职工作，还弄了一个[知识星球](https://sourl.cn/psyWaE)赚点外快，还要维护完善 JavaGuide。
111-
112-
这几年一直在默默完善，真心希望 JavaGuide 越来越好，帮助到更多朋友！也欢迎大家参与进来！

‎docs/javaguide/contribution-guideline.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: 项目贡献指南
3+
category: 走近项目
4+
---
5+
6+
欢迎参与 JavaGuide 的维护工作，这是一件非常有意义的事情。详细信息请看：[JavaGuide 贡献指南](https://zhuanlan.zhihu.com/p/464832264) 。
7+
8+
你可以从下面几个方向来做贡献：
9+
10+
- 笔记内容大多是手敲，所以难免会有笔误，你可以帮我找错别字。
11+
- 很多知识点我可能没有涉及到，所以你可以对其他知识点进行补充。
12+
- 现有的知识点难免存在不完善或者错误，所以你可以对已有知识点进行修改/补充。
13+
14+
一定一定一定要注意 **排版规范** ：
15+
16+
- [中文文案排版指北 - Github](https://github.com/sparanoid/chinese-copywriting-guidelines)
17+
- [写给大家看的中文排版指南 - 知乎](https://zhuanlan.zhihu.com/p/20506092)
18+
- [中文文案排版细则 - Dawner](https://dawner.top/posts/chinese-copywriting-rules/)
19+
20+
如果要提 issue/question 的话，强烈推荐阅读下面这些资料：
21+
22+
- [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)
23+
- [《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545)
24+
- [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/~sgtatham/bugs-cn.html)
25+
- [《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393)。

‎docs/javaguide/faq.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: 常见问题
3+
category: 走近项目
4+
---
5+
6+
7+
## 如何看待 JavaGuide 的 star 数量很多？
8+
9+
[JavaGuide](https://github.com/Snailclimb) 目前已经是 Java 领域 star 数量最多的几个项目之一，登顶过很多次 Github Trending。
10+
11+
不过，这个真心没啥好嘚瑟的。因为，教程类的含金量其实是比较低的，star 数量比较多主要也是因为受众面比较广，大家觉得不错，点个 star 就相当于收藏了。很多特别优秀的框架，star 数量可能只有几 K。所以，单纯看 star 数量没啥意思，就当看个笑话吧！
12+
13+
维护这个项目的过程中，也被某些人 diss 过：“md 项目，没啥含金量，给国人丢脸！”。
14+
15+
对于说这类话的人，我觉得对我没啥影响，就持续完善，把 JavaGuide 做的更好吧！其实，国外的很多项目也是纯 MD 啊！就比如外国的朋友发起的 awesome 系列、求职面试系列。无需多说，行动自证！凎！
16+
17+
开源非常重要的一点就是协作。如果你开源了一个项目之后，就不再维护，别人给你提交 issue/pr，你都不处理，那开源也没啥意义了！
18+
19+
## JavaGuide 会不会推出纸质书籍？
20+
21+
可以给出一个比较明确的答案：**暂时没有考虑出书** 。
22+
23+
JavaGuide 这个项目诞生一年左右就有出版社的老师联系我了，由于自知个人能力尚需沉淀，我都婉拒了。这几年的话，由于项目还是有一点知名度的，找我出书的出版社老师更多了，也都被我一一婉拒了。
24+
25+
**出书既能博名又能赚点钱，我为啥不考虑出书呢？**
26+
27+
1. JavaGuide 的很多内容我还不是很满意，也一直在维护中，细心的小伙伴看我的提交记录就明白了。
28+
2. 开源版本更容易维护和修改，也能让更多人更方便地参与到项目的建设中，这也是我最初做这个项目的初衷。
29+
3. 我觉得出书是一件神圣的事情，自认能力还不够。
30+
4. 个人精力有限，不光有本职工作，还弄了一个[知识星球](https://sourl.cn/psyWaE)赚点外快，还要维护完善 JavaGuide。
31+
32+
这几年一直在默默完善，真心希望 JavaGuide 越来越好，帮助到更多朋友！也欢迎大家参与进来！

‎docs/javaguide/intro.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: 项目介绍
3+
category: 走近项目
4+
---
5+
6+
在大三准备面试的时候，我开源了 JavaGuide 。我把自己准备面试过程中的一些总结都毫不保留地通过 JavaGuide 分享了出来。
7+
8+
开源 JavaGuide 初始想法源于自己的个人那一段比较迷茫的学习经历。主要目的是为了通过这个开源平台来帮助一些在学习 Java 或者面试过程中遇到问题的小伙伴。
9+
10+
- **对于 Java 初学者来说：** 本文档倾向于给你提供一个比较详细的学习路径，让你对于 Java 整体的知识体系有一个初步认识。另外，本文的一些文章也是你学习和复习 Java 知识不错的实践；
11+
- **对于非 Java 初学者来说：** 本文档更适合回顾知识，准备面试，搞清面试应该把重心放在那些问题上。要搞清楚这个道理：提前知道那些面试常见，不是为了背下来应付面试，而是为了让你可以更有针对的学习重点。
12+
13+
相比于其他通过 JavaGuide 学到东西或者说助力获得 offer 的朋友来说 ， JavaGuide 对我的意义更加重大。不夸张的说，有时候真的感觉像是自己的孩子一点一点长大一样，我一直用心呵护着它。虽然，我花了很长时间来维护它，但是，我觉得非常值得！非常有意义！
14+
15+
希望大家对面试不要抱有侥幸的心理，打铁还需自身硬！ 我希望这个文档是为你学习 Java 指明方向，而不是用来应付面试用的。加油！奥利给！
16+
17+
## 项目说明
18+
19+
- 项目的 Markdown 格式参考：[Github Markdown 格式](https://guides.github.com/features/mastering-markdown/)，表情素材来自：[EMOJI CHEAT SHEET](https://www.webpagefx.com/tools/emoji-cheat-sheet/)。
20+
- Logo 下的小图标是使用[Shields.IO](https://shields.io/) 生成的。
21+
22+
## 贡献者
23+
24+
[你可以点此链接查看 JavaGuide 的所有贡献者。](https://github.com/Snailclimb/JavaGuide/graphs/contributors) 感谢你们让 JavaGuide 变得更好！如果你们来到武汉一定要找我，我请你们吃饭玩耍。
25+
26+
欢迎参与 [JavaGuide 的维护工作](https://zhuanlan.zhihu.com/p/464832264)，这是一件非常有意义的事情。

‎docs/javaguide/todo.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: 项目代办
3+
category: 走近项目
4+
---
5+
6+
- [x] 数据结构内容完善
7+
- [x] Java 基础内容完善
8+
- [x] 大篇幅文章拆分
9+
- [ ] JVM 内容更新完善
10+
- [ ] 计算机网络知识点完善
11+
- [ ] 分布式常见理论和算法总结完善
12+
13+
欢迎参与 JavaGuide 的维护工作，这是一件非常有意义的事情。详细信息请看：[JavaGuide 贡献指南](./contribution-guideline.md) 。
14+

0 commit comments

Comments
 (0)