Skip to content

Commit 39d0bd5

Browse files
committed
feat: add documentation site generator
1 parent 92cbd8a commit 39d0bd5

File tree

9 files changed

+123
-9
lines changed

9 files changed

+123
-9
lines changed

.nojekyll

Whitespace-only changes.

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,22 @@
22
Hello, everyone! Welcome to the [Doocs](https://github.com/doocs) Open Source organization. The name is originated from ‘Docs’, which mainly shares various development-related knowledge in the form of documents.
33

44
## Projects
5-
Doocs now has the following six projects excluding [intro](https://github.com/doocs/intro):
5+
Doocs now has the following projects excluding [intro](https://github.com/doocs/intro):
6+
7+
| # | Project | Description |
8+
|---|---|---|
9+
| 1 | [advanced-java](https://github.com/doocs/advanced-java) | A learning roadmap of advanced knowledge for Java developers. |
10+
| 2 | [technical-books](https://github.com/doocs/technical-books) | Awesome programming books list. |
11+
| 3 | [jvm](https://github.com/doocs/jvm) | A summary of the underlying principles of Java Virtual Machine. |
12+
| 4 | [leetcode](https://github.com/doocs/leetcode) | LeetCode solutions in any programming language. |
13+
| 5 | [coding-interview](https://github.com/doocs/coding-interview) | A collection of interview questions for programmers. The main contents include ‘Coding Interviews: Questions, Analysis and Solutions’, ‘Beauty of Programming’, etc. |
14+
| 6 | [spider](https://github.com/doocs/spider) | A record of crawler-related knowledge points. |
15+
| 7 | [data-structure-and-algorithm](https://github.com/doocs/data-structure-and-algorithm) | Knowledge about data structures and algorithms. |
16+
| 8 | [awesome-python](https://github.com/doocs/awesome-python) | A collection of (mostly) technical things every pythoner should know. |
617

7-
- [advanced-java](https://github.com/doocs/advanced-java): A learning roadmap of advanced knowledge for Java developers.
8-
- [technical-books](https://github.com/doocs/technical-books): Awesome programming books list.
9-
- [leetcode](https://github.com/doocs/leetcode): LeetCode solutions in any programming language.
10-
- [coding-interview](https://github.com/doocs/coding-interview): A collection of interview questions for programmers. The main contents include ‘Coding Interviews: Questions, Analysis and Solutions’, ‘Beauty of Programming’, etc.
11-
- [jvm](https://github.com/doocs/jvm): A summary of the underlying principles of Java Virtual Machine.
12-
- [spider](https://github.com/doocs/spider): A record of crawler-related knowledge points.
1318

1419
## How to join
15-
*If you want to go fast, go alone. If you want to go far, go together.*
20+
> *If you want to go fast, go alone. If you want to go far, go together.*
1621
1722
I believe many of you have a deep understanding that participating in open source projects is very helpful for personal growth. If you love open source or you are curious about it, join Doocs, work with us, maintain our projects and grow together. You can join us in the following two ways:
1823

@@ -35,4 +40,4 @@ This organization exists thanks to all the people who contribute.
3540
<a href="https://opencollective.com/doocs/contributors.svg?width=890&button=true"><img src="https://opencollective.com/doocs/contributors.svg?width=890&button=false" /></a>
3641

3742
## Documentation
38-
See the [中文文档](https://github.com/doocs/intro/wiki/%E4%BB%8B%E7%BB%8D) for Chinese README.
43+
See the [中文文档](README_CN) for Chinese README.

README_CN.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 介绍
2+
你好,欢迎来到 [Doocs](https://github.com/doocs) 开源组织。Doocs 名字取自 Docs,主要是以文档的形式分享各种开发相关知识。
3+
4+
## 项目
5+
目前 Doocs 有以下多个项目:
6+
7+
| # | 项目名称 | 项目描述 |
8+
|---|---|---|
9+
| 1 | [advanced-java](https://github.com/doocs/advanced-java) | 互联网 Java 工程师进阶知识完全扫盲。 |
10+
| 2 | [technical-books](https://github.com/doocs/technical-books) | 值得一看的技术书籍列表。 |
11+
| 3 | [jvm](https://github.com/doocs/jvm) | Java 虚拟机底层原理知识总结。 |
12+
| 4 | [leetcode](https://github.com/doocs/leetcode) | LeetCode 多语言题解及解析。 |
13+
| 5 | [coding-interview](https://github.com/doocs/coding-interview) | 代码面试题集,包括《剑指 Offer》、《编程之美》等。 |
14+
| 6 | [spider](https://github.com/doocs/spider) | 记录爬虫相关知识点。 |
15+
| 7 | [data-structure-and-algorithm](https://github.com/doocs/data-structure-and-algorithm) | 学习数据结构与算法,夯实编程基础。 |
16+
| 8 | [awesome-python](https://github.com/doocs/awesome-python) | Pythoner 必须掌握的知识点。 |
17+
18+
## 如何加入
19+
20+
> *If you want to go fast, go alone. If you want to go far, go together.*
21+
22+
参与开源项目,对于个人的成长是有很大帮助的,相信很多小伙伴都有体会。
23+
24+
如果你热爱开源,或者抱着一颗好奇的心,不妨加入 [Doocs](https://github.com/doocs) 组织,和我们一起维护项目,共同成长。可以通过以下两种方式加入:
25+
26+
- 直接在[此项目](https://github.com/doocs/intro)[issue](https://github.com/doocs/intro/issues) 上交流。
27+
- 发送邮件到 [contact@yanglibin.info](mailto:contact@yanglibin.info),写明你的 GitHub ID,如 [yanglbme](https://github.com/yanglbme)
28+
29+
加入之后,你可以在[这里](https://github.com/orgs/doocs/people)设置可见性,我们建议设置为 Public,直接对外界公开。
30+
31+
**注意**,刚开始加入,你**暂时**不会有项目的直接 write 权限,因为我们不确定你的提交是否符合项目规范。
32+
33+
你可以 fork 任何一个感兴趣的项目到你的个人 GitHub 帐户下,对项目作出修改后,提交你的 PR。Doocs 维护者会对你的提交内容进行 review。或许你最初的提交并不规范,这也没关系,改进之后,慢慢的,整个规范性就有了。当你的提交一直很符合项目的规范性,Doocs 维护者会将你添加到对应项目的 Collaborators 列表中,共同维护好项目。
34+
35+
如果你不熟悉 GitHub 操作流程,可以参考[这篇文章](https://github.com/doocs/leetcode/blob/master/.github/CONTRIBUTING.md)
36+
37+
Doocs 期待你的加入。
38+
39+
## 贡献者列表
40+
感谢以下所有为此开源组织贡献的开发者朋友们。
41+
42+
<a href="https://opencollective.com/doocs/contributors.svg?width=890&button=false"><img src="https://opencollective.com/doocs/contributors.svg?width=890&button=false" /></a>
43+
44+
## 其他语言文档
45+
英文文档请看 [README](README)

images/favicon-16x16.png

1.23 KB
Loading

images/favicon-32x32.png

23 KB
Loading

images/qrcode_for_doocs.jpg

-27.3 KB
Binary file not shown.

images/qrcode_for_wechatgroup.jpg

-102 KB
Binary file not shown.

images/qrcode_for_yanglbme.jpg

-101 KB
Binary file not shown.

index.html

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Welcome to join the Doocs Open Source organization</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7+
<meta name="description" content="Description">
8+
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
9+
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
10+
<link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png">
11+
<link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png">
12+
</head>
13+
<body>
14+
<nav>
15+
<ul>
16+
<li>Translations
17+
<ul>
18+
<li><a href="#README_CN">中文</a></li>
19+
<li><a href="#">English</a></li>
20+
</ul>
21+
</li>
22+
</ul>
23+
24+
</nav>
25+
<div id="app"></div>
26+
<script>
27+
window.$docsify = {
28+
name: 'Doocs',
29+
repo: 'doocs/intro',
30+
auto2top: true,
31+
search: [
32+
'/'
33+
],
34+
disqus: 'shortname',
35+
plugins: [
36+
function (hook) {
37+
var footer = [
38+
'<hr/>',
39+
'<footer>',
40+
'<span>Copyright © 2019 <a href="https://github.com/doocs" target="_blank">Doocs</a> All rights reserved.</span>',
41+
'</footer>'
42+
].join('')
43+
44+
hook.afterEach(function (html) {
45+
return html + footer
46+
})
47+
}
48+
]
49+
}
50+
</script>
51+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
52+
<script src="//unpkg.com/prismjs/components/prism-c.min.js"></script>
53+
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
54+
<script src="//unpkg.com/prismjs/components/prism-cpp.min.js"></script>
55+
<script src="//unpkg.com/prismjs/components/prism-json.min.js"></script>
56+
<script src="//unpkg.com/prismjs/components/prism-java.min.js"></script>
57+
<script src="//unpkg.com/prismjs/components/prism-python.min.js"></script>
58+
<script src="//unpkg.com/docsify-copy-code"></script>
59+
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
60+
<script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
61+
<script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
62+
<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
63+
</body>
64+
</html>

0 commit comments

Comments
 (0)