Skip to content

Commit 4c48902

Browse files
floydzhang1984floydzhang1984
authored andcommitted
Merge branch 'wenquan0hf-master'
2 parents f250237 + afac55e commit 4c48902

25 files changed

+227
-36
lines changed

README.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,44 @@
1-
# 极客学院 Wiki 协作规范
1+
# 欢迎来到极客学院 Wiki
22

3-
极客学院 Wiki 采用在线协作,所有文件都直接提交到 GitHub 之上,文字撰写采用 Markdown 极简文本语法,舍弃繁琐的 Word 排版。
3+
## 关于极客学院 Wiki
44

5-
## 实例
5+
极客学院 Wiki 是集作者创作,内容展示,书籍出版,技术交流为一身的 IT 在线图文教育平台。目前已经有 100 W 用户通过我们的平台奔跑在极客的路上。已有 30+ 种类的课程,100 多门教程供大家学习参考。
66

7-
Apple Watch 人机交互指南
8-
<http://wiki.jikexueyuan.com/project/apple-watch-human-interface-guidelines/>
7+
欢迎访问极客学院 Wiki 网站:[wiki.jikexueyuan.com](http://wiki.jikexueyuan.com/)
98

10-
## 协作步骤
9+
## 为什么选择我们的平台创作?
1110

12-
协同者只需按照本规范,step by step,就能迅速上手,亲身感受在线协同的便利和高效
11+
一、IT 在线教育领域最专业的平台,这里有最优质的内容供大家学习
1312

14-
### 第一步:学习 Markdown 语法(花费 5 分钟)
13+
二、简单极致的创作风格,辅助当下流行的编辑工具,让你的创作更加简单。
1514

16-
详见文档:[Markdown 五分钟速成](markdown.md)
15+
三、精品书籍出版,圈内大神在线指导,让你的人生多些选择。
1716

18-
### 第二步:学习 极客学院文案风格指南(花费 5 分钟)
17+
四、比博客更系统的知识体系,比其他 Wiki 网站更友好时尚的界面。
1918

20-
详见文档:[极客学院文案风格指南](copywriting-guide.md)
19+
五、尊重作者,善待读者是我们的原则。
2120

22-
### 第三步:学习 GitHub 使用方法(花费 10 分钟)
21+
## 合作须知
2322

24-
- Windows 用户详见文档:
25-
<http://wiki.jikexueyuan.com/project/github-basics/github-for-windows.html>
23+
1. 极客学院因业务开展需要,在对作者学识背景进行相关了解的情况下,聘请为极客学院原创作者,按照《极客学院Wiki 协作手册》对合作内容进行制作,并在此基础上建立长期合作关系。 

2624

27-
- Mac 用户详见文档:
28-
<http://wiki.jikexueyuan.com/project/github-basics/github-for-mac.html>
25+
2. 极客(公司/平台)尊重作者署名方式、写作内容和风格,但本作品出现如错别字、语法、常识性错误,文字润色以及不符合国家有关政策和出版规范之处,极客(公司/平台)有权(义务)要求作者修改。同时可在不改变作品内容和基本风格的条件下对作品进行删改,但整个章节的删节和重要删改必须征得作者同意。
2926

30-
### 第四步:开始撰写
27+
3. 作者保证不侵犯第三方权益,也不会被第三方追索。如发生第三方权益受到侵犯,作者应积极配合极客(公司/平台)进行应对,承担相对的损失。
28+
29+
## 极客学院 Wiki 协作手册
30+
31+
Wiki 协作采用 Markdown+Github 极简工具进行创作,下面的步骤,包括 Wiki 创作的整个过程:
32+
33+
第一步:[注册 GitHub,创建仓库(花费 10 分钟)](learn-github.md)
34+
35+
第二步;[Markdown 五分钟速成(花费 5 分钟)](markdown.md)
36+
37+
第三步;[创建基础文件结构,开始撰写(根据内容多少而定)](toc-struct.md)
38+
39+
第四步;[极客学院文案风格指南(花费 5 分钟)](copywriting-guide.md)
40+
41+
第五步:[提交,上线](submit-online.md)
3142

32-
1. 了解仓库的目录结构
33-
目录结构规范:[目录结构](toc-struct.md)
34-
2. 查阅仓库的「目录」文件,目录文件文件名固定为「TOC.md」,位于仓库的根目录之下
35-
目录示例:[TOC.md](TOC.md)
36-
3. 点击对应的章节文件开始撰写内容
37-
章节示例:[极客学院文案风格规范](copywriting-guide.md)
3843

3944

TOC.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,10 @@
44
- [目录结构](toc-struct.md)
55
- [自定义参数](config.md)
66
- [常用专业词汇](glossary.md)
7-
7+
- 协作步骤
8+
- [第一步 注册 GitHub,创建仓库](learn-github.md)
9+
- [第二步 Markdown 五分钟速成](markdown.md)
10+
- [第三步 创建基础文件结构,开始撰写](toc-struct.md)
11+
- [第四步 极客学院文案风格指南](copywriting-guide.md)
12+
- [第五步 提交,上线](submit-online.md)
13+
- [常见问题](faq.md)

config.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"name": "极客学院 Wiki 合作指南",
3+
"introduction": "本文旨在帮助作者快速上手,创作 Wiki 内容。",
4+
5+
}

copywriting-guide.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 极客学院文案风格指南
1+
# 第四步 极客学院文案风格指南
22

33
## 空格
44

@@ -16,7 +16,7 @@
1616

1717
## 英文单词大小写
1818

19-
- 所有的专业词汇必须和对应官网一样,详见 [常用专业词汇](glossary.md)
19+
- 所有的专业词汇要和对应官网一样,详见 [常用专业词汇](glossary.md)
2020

2121
## 段落
2222

@@ -31,4 +31,43 @@
3131

3232
- Markdown 文件:英文小写(多个英文减号连接);
3333
正确:copywriting-guide.md
34-
错误:copywriting_guide.md、copywritingGuide.md、CopywritingGuide.md、copywriting guide.md
34+
错误:copywriting_guide.md、copywritingGuide.md、CopywritingGuide.md、copywriting guide.md
35+
36+
## 表格形式举例
37+
38+
markdown 格式
39+
40+
格式:
41+
42+
```
43+
| Tables | Are | Cool |
44+
|:------------- |:-------------|:-----|
45+
| col 3 is | right-aligned | $1600 |
46+
| col 2 is | centered | $12 |
47+
| zebra stripes | are neat | $1 |
48+
```
49+
>注意: |:----| (左对齐) |:------:|(居中 ) |------:| (右对齐)。`:-` 之间不要有空格。
50+
51+
样式:
52+
53+
| Tables | Are | Cool |
54+
|:------------- |:-------------|:-----|
55+
| col 3 is | right-aligned | $1600 |
56+
| col 2 is | centered | $12 |
57+
| zebra stripes | are neat | $1 |
58+
59+
## 目录标题
60+
61+
目录标题与每篇文章的标题要一致。
62+
63+
### 目录
64+
65+
![](images/cg.png)
66+
67+
### 文章标题
68+
69+
![](images/cg1.png)
70+
71+
72+
73+

cover/background.jpg

12.9 KB
Loading

cover/logo.png

7.08 KB
Loading

faq.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 常见问题
2+
3+
Q:文章中有些代码为 HTML 标签,如`<tr>``<td>`等,在 Markdown 预览模式不显示怎么办?
4+
5+
A:因为最终所有的内容还是要转换成 HTML 代码在网页上显示的,遇到这种情况,处理方法如下
6+
7+
```
8+
`<标签>`
9+
```
10+

images/begin.png

9.24 KB
Loading

images/cg.png

4.39 KB
Loading

images/cg1.png

21.4 KB
Loading

0 commit comments

Comments
 (0)