├── README.md ├── README_Origin.md ├── TOC.md ├── about.md ├── config-json.md ├── config.json ├── config.md ├── contact-us.md ├── cooperate.md ├── copywriting-guide.md ├── cover ├── background.jpg └── logo.png ├── faq.md ├── first-commit.md ├── glossary.md ├── images ├── 1.png ├── 2.png ├── 3.png ├── begin.png ├── cg.png ├── cg1.png ├── cincot.png ├── config.png ├── content.png ├── cover.png ├── create-new-repository-1.png ├── create-new-repository-2.png ├── create-new-repository-3.png ├── create-new-repository-4.png ├── create-new-repository-5.png ├── create-new-repository-6.png ├── example.png ├── guide6.png ├── m.png ├── new-file.png ├── oper.png ├── oper1.png ├── pull_request.png ├── pull_request2.png ├── rename.png ├── settings.png ├── submit.png ├── toc.png ├── toc1.png ├── toc2.png ├── toc3.png ├── toc4.png ├── webhook1.png ├── webhook2.png ├── webhook3.png ├── webhook4.png ├── webhook5.png ├── webhook6.png ├── webhook7.png ├── write1.png └── write2.png ├── inform-us.md ├── learn-github.md ├── markdown.md ├── merge-cover.md ├── operate-toc.md ├── put-online.md ├── setup-repo.md ├── start-write.md ├── start-writing.md ├── submit-online.md ├── test.md ├── toc-struct.md ├── webhook-config.md ├── why-us.md └── wiki-show.md /README.md: -------------------------------------------------------------------------------- 1 | # 极客学院 Wiki 作者帮助中心 2 | 3 | 本手册包涵了 Wiki 创作的整个过程，新手只需一步步按手册操作就能完成。 4 | 5 | >同时，我们已经完美兼容 GitBook，只需花费几分钟时间通过简单地配置，就能搞定。如果你是 GitBook 用户，那么直接从 [配置 Webhook](webhook-config.md) 章节开始。 6 | 7 | >如果您不了解GitBook，那么你可以从[第一步，Fork 示例仓库](setup-repo.md)开始，只需要一步步操作，10分钟就能上手。 8 | 9 | ## 投入与产出 10 | 11 | ![](images/cincot.png) 12 | 13 | ## 目录 14 | 15 | - [关于我们](about.md) 16 | - [第一步，Fork 示例仓库](setup-repo.md) 17 | - [第二步，修改仓库名](operate-toc.md) 18 | - [第三步，撰写内容](start-writing.md) 19 | - [第四步，配置 Webhook](webhook-config.md) 20 | - [第五步，通知我们](inform-us.md) 21 | - [发布上线](put-online.md) 22 | - [我们的联系方式](contact-us.md) 23 | - [自定义config参数](config-json.md) 24 | 25 | 26 | -------------------------------------------------------------------------------- /README_Origin.md: -------------------------------------------------------------------------------- 1 | # 欢迎来到极客学院 Wiki 2 | 3 | ## 关于极客学院 Wiki 4 | 5 | 极客学院 Wiki 是集作者创作，内容展示，书籍出版，技术交流为一身的 IT 在线图文教育平台。目前已经有 100 W 用户通过我们的平台奔跑在极客的路上。已有 30+ 种类的课程，100 多门教程供大家学习参考。 6 | 7 | 欢迎访问极客学院 Wiki 网站：[wiki.jikexueyuan.com](http://wiki.jikexueyuan.com/)。 8 | 9 | ## 为什么选择我们的平台创作？ 10 | 11 | 一、IT 在线教育领域最专业的平台，这里有最优质的内容供大家学习。 12 | 13 | 二、简单极致的创作风格，辅助当下流行的编辑工具，让你的创作更加简单。 14 | 15 | 三、精品书籍出版，圈内大神在线指导，让你的人生多些选择。 16 | 17 | 四、比博客更系统的知识体系，比其他 Wiki 网站更友好时尚的界面。 18 | 19 | 五、尊重作者，善待读者是我们的原则。 20 | 21 | ## 合作须知 22 | 23 | 1. 极客学院因业务开展需要,在对作者学识背景进行相关了解的情况下,聘请为极客学院原创作者,按照《极客学院Wiki 协作手册》对合作内容进行制作,并在此基础上建立长期合作关系。 
 24 | 25 | 2. 极客(公司/平台)尊重作者署名方式、写作内容和风格，但本作品出现如错别字、语法、常识性错误，文字润色以及不符合国家有关政策和出版规范之处，极客(公司/平台)有权(义务)要求作者修改。同时可在不改变作品内容和基本风格的条件下对作品进行删改，但整个章节的删节和重要删改必须征得作者同意。 26 | 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) 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /TOC.md: -------------------------------------------------------------------------------- 1 | - [关于我们](about.md) 2 | - [第一步，Fork 示例仓库](setup-repo.md) 3 | - [第二步，修改仓库名](operate-toc.md) 4 | - [第三步，撰写内容](start-writing.md) 5 | - [第四步，配置 Webhook](webhook-config.md) 6 | - [第五步，通知我们](inform-us.md) 7 | - [发布上线](put-online.md) 8 | - [我们的联系方式](contact-us.md) 9 | - [自定义config参数](config-json.md) 10 | 11 | -------------------------------------------------------------------------------- /about.md: -------------------------------------------------------------------------------- 1 | # 关于我们 2 | 3 | ## 关于极客学院 4 | 5 | 极客学院 IT 在线教育平台隶属于北京优亿致远无线技术有限公司。 6 | 7 | 极客学院是中国最大的 IT 职业在线教育平台。极客学院的理念是通过最新实战课程,帮助职业开发者系统学习 Android、Cocos2d-x、iOS、HTML5、Java 等⾼薪所需的职业开发技能。⽬前，超过 45 万专业技术开发者通过极客学院学得了更有竞争力的最新 IT 技能。 8 | 9 | 2014 年，中国几乎所有的热门技术及应⽤用课程,都由极客学院首发。包括：中国第一个 「Flappy Bird」课程、中国第一个「2048」的课程、中国第一个「围住神经猫」等诸多中国乃至全球首发课程。在六月份，WWDC 苹果发布全新的 Swift 开发语言时，极客学院更是 7 个小时就上线了 Swift 的开发课程。 10 | 11 | ## 关于 Wiki 12 | 13 | 极客学院 WiKi ([wiki.jikexueyuan.com](http://wiki.jikexueyuan.com)) 是集高质量内容，技术分享，作品出版，技术交流为一身的 IT 在线图文教育平台。 14 | 15 | 我们有专业的技术开发者分享自己的技术，有机会与各技术领域的大牛同台出版作品，有简洁时尚的开发工具供大家使用，有一个非常具有极客精神的团队为此保驾护航。 16 | 17 | 我们已经有大约 40+ 种类的课题，200 多门教程，我的课程来源于广大的具有极客精神的贡献者。如果你苦于 word 排版的麻烦、苦于原创内容被恶意转载或是找不到合适平台展示、苦于找不到那群热爱极客精神的人，那么，加入我们吧！ 18 | 19 | ## 为什么选择我们 20 | 21 | 一、IT 在线教育领域最专业的平台，构建读者与作者之间的桥梁，让沟通更方便，让学习更有效。 22 | 23 | 二、体验 Wiki 制作的每个过程，你不再只是内容的观看者，而是内容的创造者。 24 | 25 | 三、简单极致的创作风格，辅助当下流行的编辑工具，让你的创作更加简洁高效。 26 | 27 | 四、精品书籍出版，圈内大神在线指导，让你的人生多些选择。 28 | 29 | 五、比博客更系统的知识体系，比其他 Wiki 网站更友好时尚的界面。 30 | 31 | 六、尊重作者，善待读者是我们的原则。 32 | 33 | 七、我们的目标是，集大家的力量，让学习更加容易，将开源与免费进行到底。 34 | 35 | **接下来让我们开始创作吧，首先我们需要一个仓库，我们已经提供一个 Demo ，所以你可以直接[Fork仓库](setup-repo.md)**。 36 | 37 | -------------------------------------------------------------------------------- /config-json.md: -------------------------------------------------------------------------------- 1 | # 自定义参数 2 | 3 | ## 规则 4 | 5 | 可以通过根目录下的 `config.json` 文件配置自定义参数，具体如下： 6 | 7 | ```json 8 | { 9 | "name": "项目名称，必填", 10 | "introduction": "Wiki 首页的项目介绍，必填", 11 | "title": "页面的 title 标签的内容，非必填", 12 | "keywords": "页面的 keywords 标签的内容，非必填", 13 | "description": "页面的 description 标签的内容，非必填", 14 | "path": { 15 | "content": "正文的文件夹路径，相对路径绝对路径皆可，默认根目录，非必填", 16 | "images": "引用图片的文件夹路径，相对路径绝对路径皆可，默认为根目录下的 images 文件夹，非必填", 17 | "readme": "关于页面的路径，相对路径绝对路径皆可，默认根目录下的 README.md，非必填", 18 | "toc": "目录的路径，相对路径绝对路径皆可，默认根目录下的 TOC.md，非必填" 19 | } 20 | } 21 | ``` 22 | 23 | ## 示例 24 | 25 | GitHub 仓库地址： 26 | 27 | Wiki 项目地址： 28 | 29 | ```json 30 | { 31 | "name": "Go 入门指南", 32 | "introduction": "Go 经典书籍《The Way To Go》的中文译本。", 33 | "path": { 34 | "content": "eBook", 35 | "readme": "README_gc.md" 36 | } 37 | 38 | } 39 | ``` 40 | 41 | 配置好后，我们就可以通知极客学院 Wiki，进行下一步操作[通知我们](inform-us.md)。 -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "极客学院 Wiki 作者帮助中心", 3 | "introduction": "本文旨在帮助作者快速上手，创作 Wiki 内容。" 4 | 5 | } 6 | -------------------------------------------------------------------------------- /config.md: -------------------------------------------------------------------------------- 1 | # 自定义参数 2 | 3 | ## 规则 4 | 5 | 可以通过根目录下的 `config.json` 文件配置自定义参数，具体如下： 6 | 7 | ```json 8 | { 9 | "name": "项目名称，必填", 10 | "introduction": "Wiki 首页的项目介绍，必填", 11 | "title": "页面的 title 标签的内容，非必填", 12 | "keywords": "页面的 keywords 标签的内容，非必填", 13 | "description": "页面的 description 标签的内容，非必填", 14 | "path": { 15 | "content": "正文的文件夹路径，相对路径绝对路径皆可，默认根目录，非必填", 16 | "images": "引用图片的文件夹路径，相对路径绝对路径皆可，默认为根目录下的 images 文件夹，非必填", 17 | "readme": "关于页面的路径，相对路径绝对路径皆可，默认根目录下的 README.md，非必填", 18 | "toc": "目录的路径，相对路径绝对路径皆可，默认根目录下的 TOC.md，非必填" 19 | } 20 | } 21 | ``` 22 | 23 | ## 示例 24 | 25 | GitHub 仓库地址： 26 | 27 | Wiki 项目地址： 28 | 29 | ```json 30 | { 31 | "name": "Go 入门指南", 32 | "introduction": "Go 经典书籍《The Way To Go》的中文译本。", 33 | "path": { 34 | "content": "eBook", 35 | "readme": "README_gc.md" 36 | } 37 | 38 | } 39 | ``` 40 | -------------------------------------------------------------------------------- /contact-us.md: -------------------------------------------------------------------------------- 1 | # 我们的联系方式 2 | 3 | 如有任何问题，可用以下方式联系我们： 4 | 5 | ## 邮件 6 | 7 | wiki@jikexueyuan.com 8 | 9 | ## 作者 QQ 群 10 | 11 | 作者 QQ 群：323037186 12 | -------------------------------------------------------------------------------- /cooperate.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/cooperate.md -------------------------------------------------------------------------------- /copywriting-guide.md: -------------------------------------------------------------------------------- 1 | # 第四步 极客学院文案风格指南 2 | 3 | ## 空格 4 | 5 | - 中英文之间需要有空格，例如：Apple Watch 将于下周开始接受预订。 6 | - 中文与数字之间需要有空格，例如：下午跑步 1 小时。 7 | - 数字与单位之间需要有一个空格，例如：是「5 GB」而不是「5GB」。 8 | - 全角标点符号与其他之间不需要空格。 9 | 10 | ## 标点符号 11 | 12 | - 只有中文或中英文混排中，一律使用中文/全角标点。 13 | - 中英文混排中如果出现整句英文，则在这句英文中使用英文/半角标点。 14 | - 中文标点与其他字符间一律不加空格。 15 | - 尽量避免重复使用标点（尤其是叠加感叹号、问号等），例如「！！！」； 16 | 17 | ## 英文单词大小写 18 | 19 | - 所有的专业词汇要和对应官网一样，详见 [常用专业词汇](glossary.md) 20 | 21 | ## 段落 22 | 23 | - 段落开头不要留出空白字符，顶格写。 24 | - 段落之间使用一个空行隔开。 25 | 26 | ## 文件命名 27 | 28 | - 文件夹：英文小写（多个英文减号连接）； 29 | 正确：copywriting-guide 30 | 错误：copywriting_guide、copywritingGuide、CopywritingGuide、copywriting guide 31 | 32 | - Markdown 文件：英文小写（多个英文减号连接）； 33 | 正确：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 | 74 | -------------------------------------------------------------------------------- /cover/background.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/cover/background.jpg -------------------------------------------------------------------------------- /cover/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/cover/logo.png -------------------------------------------------------------------------------- /faq.md: -------------------------------------------------------------------------------- 1 | # 常见问题 2 | 3 | Q：文章中有些代码为 HTML 标签，如``、``等，在 Markdown 预览模式不显示怎么办？ 4 | 5 | A：因为最终所有的内容还是要转换成 HTML 代码在网页上显示的，遇到这种情况，处理方法如下 6 | 7 | ``` 8 | `<标签>` 9 | ``` 10 | 11 | -------------------------------------------------------------------------------- /first-commit.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/first-commit.md -------------------------------------------------------------------------------- /glossary.md: -------------------------------------------------------------------------------- 1 | # 常用专业词汇 2 | 3 | - HBase 4 | - Ruby on Rails 5 | - Node.js 6 | - Objective-C（错误：Objective-c、ObjectiveC） 7 | - JSON（错误：json、Json） 8 | - XML（错误：xml、Xml） 9 | - HTTP（错误：http） 10 | - UI（错误：Ui、ui） 11 | - AJAX（错误：Ajax、AJax） 12 | - jQuery（错误：Jquery） 13 | - DOM（错误：dom） 14 | - JavaScript（错误：Javascript、javascript） 15 | - XHTML（错误：xhtml） 16 | - Web（错误：web） 17 | - SDK（错误：sdk） 18 | - Unity 3D（错误：unity 3d、Unity3D） 19 | - HTML（错误：html） 20 | - HTML5（错误：html5、html 5、HTML 5） 21 | - CSS（错误：css） 22 | - CSS3（错误：css3、CSS 3） 23 | - VIP（错误：vip、Vip） 24 | - Cocos（错误：cocos） 25 | - Cocos2d-x（错误：Cocos2d-X、Cocos2dx） 26 | - Cocos2d-JS（错误：Cocos2d-JS） 27 | - Xcode（错误：xCode、XCode） 28 | - Android（错误：android、安卓） 29 | - API（错误：api、Api） 30 | - iOS（错误：IOS、ios） 31 | - iOS 8（错误：iOS8） 32 | - OS X （错误：os x、OS x） 33 | - iPhone（错误：iphone、IPhone） 34 | - iPhone 6（错误：iPhone6） 35 | - iPhone 5s（错误：iPhone 5S） 36 | - iPad（错误：ipad、Ipad） 37 | - iCloud（错误：icloud、Icloud） 38 | - App（错误：app、APP） 39 | - PDF（错误：pdf） 40 | - Mac（错误：mac、MAC） 41 | - ID（错误：id、Id） -------------------------------------------------------------------------------- /images/1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/1.png -------------------------------------------------------------------------------- /images/2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/2.png -------------------------------------------------------------------------------- /images/3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/3.png -------------------------------------------------------------------------------- /images/begin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/begin.png -------------------------------------------------------------------------------- /images/cg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/cg.png -------------------------------------------------------------------------------- /images/cg1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/cg1.png -------------------------------------------------------------------------------- /images/cincot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/cincot.png -------------------------------------------------------------------------------- /images/config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/config.png -------------------------------------------------------------------------------- /images/content.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/content.png -------------------------------------------------------------------------------- /images/cover.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/cover.png -------------------------------------------------------------------------------- /images/create-new-repository-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/create-new-repository-1.png -------------------------------------------------------------------------------- /images/create-new-repository-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/create-new-repository-2.png -------------------------------------------------------------------------------- /images/create-new-repository-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/create-new-repository-3.png -------------------------------------------------------------------------------- /images/create-new-repository-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/create-new-repository-4.png -------------------------------------------------------------------------------- /images/create-new-repository-5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/create-new-repository-5.png -------------------------------------------------------------------------------- /images/create-new-repository-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/create-new-repository-6.png -------------------------------------------------------------------------------- /images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/example.png -------------------------------------------------------------------------------- /images/guide6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/guide6.png -------------------------------------------------------------------------------- /images/m.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/m.png -------------------------------------------------------------------------------- /images/new-file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/new-file.png -------------------------------------------------------------------------------- /images/oper.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/oper.png -------------------------------------------------------------------------------- /images/oper1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/oper1.png -------------------------------------------------------------------------------- /images/pull_request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/pull_request.png -------------------------------------------------------------------------------- /images/pull_request2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/pull_request2.png -------------------------------------------------------------------------------- /images/rename.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/rename.png -------------------------------------------------------------------------------- /images/settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/settings.png -------------------------------------------------------------------------------- /images/submit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/submit.png -------------------------------------------------------------------------------- /images/toc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/toc.png -------------------------------------------------------------------------------- /images/toc1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/toc1.png -------------------------------------------------------------------------------- /images/toc2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/toc2.png -------------------------------------------------------------------------------- /images/toc3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/toc3.png -------------------------------------------------------------------------------- /images/toc4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/toc4.png -------------------------------------------------------------------------------- /images/webhook1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/webhook1.png -------------------------------------------------------------------------------- /images/webhook2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/webhook2.png -------------------------------------------------------------------------------- /images/webhook3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/webhook3.png -------------------------------------------------------------------------------- /images/webhook4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/webhook4.png -------------------------------------------------------------------------------- /images/webhook5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/webhook5.png -------------------------------------------------------------------------------- /images/webhook6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/webhook6.png -------------------------------------------------------------------------------- /images/webhook7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/webhook7.png -------------------------------------------------------------------------------- /images/write1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/write1.png -------------------------------------------------------------------------------- /images/write2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/images/write2.png -------------------------------------------------------------------------------- /inform-us.md: -------------------------------------------------------------------------------- 1 | # 通知我们 2 | 3 | Webhook 和 config.json 配置好后，需要通知我们进入下一环节 4 | 5 | ## 发送通知邮件 6 | 7 | - 发送通知邮件至 wiki@jikexueyuan.com, 通知我们项目内容整理完毕 8 | - 邮件内需写明以下内容： 9 | - 项目名称及拥有者 ID 10 | - QQ 号（用于上线后通知) 11 | - Github 项目的完整地址，如：[https://github.com/numbbbbb/the-swift-programming-language-in-chinese](https://github.com/numbbbbb/the-swift-programming-language-in-chinese) 12 | 13 | 14 | ## 接受 Pull Request 15 | 16 | 我们收到邮件后，会将项目相关的封面图及 logo 等内容放在 cover 文件夹下并推送至项目，请接受并 merge pull request: 17 | 18 | ![pull_request](images/pull_request.png) 19 | 20 | ![pull_request2](images/pull_request2.png) 21 | 22 | 至此，内容已经制作完毕，等待发布上线吧[发布上线](put-online.md) -------------------------------------------------------------------------------- /learn-github.md: -------------------------------------------------------------------------------- 1 | # 第一步 注册 GitHub，创建仓库 2 | 3 | ## 注册 GitHub 账号 4 | 5 | 6 | 7 | ## 创建仓库 8 | 9 | 10 | 11 | ## 工具安装，克隆仓库到本地 12 | 13 | Windows 用户详见文档： 14 | 15 | 16 | 17 | Mac 用户详见文档： 18 | 19 | 20 | 21 | >注意：你克隆到本地的文件内至少应包含一个 README.md 文件。![](images/begin.png) 22 | 23 | 至此，你已经拥有了一个 GitHub 账号，一个远程仓库，一个本地仓库。下一步，你将要花费 5 分钟的时间了解下 [Markdown 的简单语法](markdown.md) 24 | -------------------------------------------------------------------------------- /markdown.md: -------------------------------------------------------------------------------- 1 | # 第二步 Markdown 五分钟速成 2 | 3 | ## Markdown 工具下载 4 | 5 | - Windows 用户推荐使用编辑器 MarkdownPad 6 | 下载地址： 7 | 8 | - Mac 用户推荐使用编辑器 Mou 9 | 下载地址： 10 | 11 | ## 标题 12 | 13 | 在标题内容前添加 `# + 空格` 就可以实现标题样式的添加： 14 | 15 | - 一级标题就添加一个 `#` + 空格，例如：# 我是一级标题 16 | - 二级标题就添加两个 `#` + 空格，例如：## 我是二级标题。 17 | - 三级标题就添加三个 `#` + 空格，例如：### 我是三级标题。 18 | 19 | 依次类推... 20 | 21 | ## 特殊文字处理 22 | 23 | ### 换行 24 | 25 | 书写示例： 26 | 27 | ``` 28 | 我是第一行（后面有两个空格） 29 | 我是第二行 30 | ``` 31 | 32 | 效果： 33 | 34 | 我是第一行（后面有两个空格） 35 | 我是第二行 36 | 37 | ### 加粗 38 | 39 | 书写示例： 40 | 41 | ``` 42 | **我是粗体** 43 | ``` 44 | 45 | 效果： 46 | **我是粗体** 47 | 48 | ### 标亮 49 | 50 | 书写示例： 51 | 52 | ``` 53 | `请把我标亮` 54 | ``` 55 | 56 | 效果： 57 | 58 | `请把我标亮` 59 | 60 | ## 列表 61 | 62 | ### 一级列表（不带序号） 63 | 64 | 书写示例： 65 | 66 | ``` 67 | - 列表 1（减号 + 空格） 68 | - 列表 2 69 | ``` 70 | 71 | 效果： 72 | 73 | - 列表 1（减号 + 空格） 74 | - 列表 2 75 | 76 | ### 一级列表（带序号） 77 | 78 | 书写示例： 79 | 80 | ``` 81 | 1. 列表 1（自然数 + 点 + 空格） 82 | 2. 列表 2 83 | ``` 84 | 85 | 效果： 86 | 87 | 1. 列表 1（自然数 + 点 + 空格） 88 | 2. 列表 2 89 | 90 | ### 二级列表（不带序号） 91 | 92 | 书写示例： 93 | 94 | ``` 95 | - 列表 1（一级列表：减号 + 空格） 96 | - 列表 1.1（二级列表：空格 + 减号 + 空格） 97 | - 列表 1.2 98 | - 列表 2 99 | ``` 100 | 101 | 效果： 102 | 103 | - 列表 1（一级列表：减号 + 空格） 104 | - 列表 1.1（二级列表：空格 + 减号 + 空格） 105 | - 列表 1.2 106 | - 列表 2 107 | 108 | ## 添加图片 109 | 110 | 书写示例： 111 | 112 | ``` 113 | ![图片描述性文字](图片相对地址) 114 | ``` 115 | 116 | 效果： 117 | 118 | ![我是示例图片的描述](images/example.png) 119 | 120 | ## 添加超链接 121 | 122 | 书写示例： 123 | 124 | ``` 125 | [链接描述文字（可见）](链接地址) 126 | ``` 127 | 128 | 效果： 129 | 130 | [点击跳转到极客学院](http://www.jikexueyuan.com) 131 | 132 | ## 引用 133 | 134 | 书写示例： 135 | 136 | ``` 137 | >注意： 138 | 我是引用的内容（空一行就结束引用）。 139 | ``` 140 | 141 | 效果： 142 | 143 | >注意： 144 | 我是引用的内容（空一行就结束引用）。 145 | 146 | ## 添加代码 147 | 148 | 书写示例： 149 | 150 | 
151 | ```
152 | // 代码区域的上下分别用三个 ` 括起来
153 | public class Person {
154 |     // 代码缩进请使用 四个空格，不要使用 Tab
155 | }
156 | ```
157 |
158 | 159 | 效果： 160 | 161 | ``` 162 | // 代码区域的上下分别用三个 ` 括起来 163 | public class Person { 164 | // 代码缩进请使用 四个空格，不要使用 Tab 165 | } 166 | ``` 167 | 168 | ## 锚点使用 169 | 170 | 书写示例： 171 | 172 | ``` 173 | 极客学院是中国最大的 IT 职业在线教育平台。[[锚点名]](#footnode) 174 | 175 | [锚点名]我的示例。 176 | 177 | ``` 178 | 179 | 效果： 180 | 181 | 极客学院是中国最大的 IT 职业在线教育平台。[[锚点名]](#footnode) 182 | 183 | [锚点名]我的示例。 184 | 185 | ## 特别注意 186 | 187 | 1. 英文字母与中文之间需要两边空格（英文与符号之间不空格） 188 | 2. 高亮英文之间需要两边空格 189 | 3. 代码符号\`\`\`上面需要空一行，结束```下面需要空一行 190 | 4. 中文之间和短英文之间使用中文标点 191 | 5. 一篇文章中只能出现一个＃号标题 192 | 6. 标题＃号之后需要空一格 193 | 194 | 195 | ## 表格 196 | 197 | 书写示例： 198 | 199 | ``` 200 | | Prefix | Framework | 201 | | ------------- |:-------------:| -----:| 202 | | NS | Foundation (OS X and iOS) and Application Kit (OS X) | 203 | | UI | UIKit (iOS) | 204 | | AB | Address Book | 205 | | CA | Core Animation | 206 | | CI | Core Image | 207 | ``` 208 | 209 | 效果： 210 | 211 | | Prefix | Framework | 212 | | ------------- |:-------------:| -----:| 213 | | NS | Foundation (OS X and iOS) and Application Kit (OS X) | 214 | | UI | UIKit (iOS) | 215 | | AB | Address Book | 216 | | CA | Core Animation | 217 | | CI | Core Image | 218 | -------------------------------------------------------------------------------- /merge-cover.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/merge-cover.md -------------------------------------------------------------------------------- /operate-toc.md: -------------------------------------------------------------------------------- 1 | # 第二步，修改仓库名 2 | 3 | **1、点击 Settings ，进入设置页面：** 4 | 5 | ![](images/settings.png) 6 | 7 | **2、Repository name 下修改名字并点击 Rename 按钮** 8 | 9 | 图中示例：将 swing 改为： swing-guide 10 | 11 | ![](images/rename.png) 12 | 13 | 现在，你已经解决仓库重名的问题，下面一节，我们将讲解[撰写内容](start-writing.md)。 14 | 15 | -------------------------------------------------------------------------------- /put-online.md: -------------------------------------------------------------------------------- 1 | # 发布上线 2 | 3 | - cover 目录提交后，我们会在后台操作上线 4 | 5 | - 课程上线后，我们会及时通知你（通过 QQ 或邮件） 6 | 7 | - Github 库由您自己维护，正常更新即可，您的更新都会实时显示到项目网站上，请及时关注 [wiki.jikexueyuan.com](wiki.jikexueyuan.com) 8 | 9 | - 课程上线示例： [http://wiki.jikexueyuan.com/project/swift/](http://wiki.jikexueyuan.com/project/swift/) 10 | 11 | 恭喜你完成所有任务，课程已上线！：） 12 | 13 | 如果还有任何问题，可以随时[联系我们](contact-us.md) -------------------------------------------------------------------------------- /setup-repo.md: -------------------------------------------------------------------------------- 1 | # 第一步， Fork 仓库 2 | 3 | 进入这个示例仓库：，然后 Fork 一份到自己的仓库。 4 | 5 | ## 文件目录详解 6 | 7 | - **cover/** - 存放 [官网首页](http://wiki.jikexueyuan.com/) 背景图片（图片由极客学院提供，后期整理上线时，编辑会添加） 8 | - background.png 或 background.jpg 9 | - logo.png 或 logo.jpg 10 | 11 | - **images/** - 存放图片（用到的图片文件都放在这） 12 | 13 | - **README.md** - 说明文档（**必须有**，默认 wiki 首页显示，相当于书籍的序） 14 | 15 | - **TOC.md** - 目录（**必须有**，该 wiki 的目录） 16 | 17 | - **config.json** - 书籍名称和介绍（**必须有**） 18 | 19 | 20 | ## 文章目录格式介绍 21 | 22 | `TOC.md` 文件是整本书的目录，它是各个章节的一个链接集合，下面我们举两个例子来说明： 23 | 24 | ### 简单模式 25 | 26 | ``` 27 | 28 | - [Chapter 1](chapter1.md) 29 | - [Chapter 2](chapter2.md) 30 | - [Chapter 3](chapter3.md) 31 | 32 | ``` 33 | 34 | ### 多级目录模式 35 | 36 | ``` 37 | - [Part I](part-one.md) 38 | - [Writing is nice](writing.md) 39 | - [GitBook is nice](gitbook.md) 40 | - [Part II](part-two.md) 41 | - [We love feedback](feedback_please.md) 42 | - [Better tools for authors](better_tools.md) 43 | ``` 44 | 45 | >注意：编写完 TOC.md 文件后，还需要创建对应的 md 文件（如writing.md)。 46 | 47 | 到此，你已经有了一个自己的仓库，但是为了避免仓库名重复，我们将讲解[修改仓库](operate-toc.md)。 48 | 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /start-write.md: -------------------------------------------------------------------------------- 1 | # 撰写内容 2 | 3 | 示例： 4 | 5 | ## 创建目录 6 | 7 | **[目录结构举例](https://github.com/jikexueyuanwiki/guide)** 8 | 9 | 1.目录结构规范 10 | 11 | [目录结构](toc-struct.md) 12 | 13 | 2.查阅仓库的「目录」文件，目录文件文件名固定为「TOC.md」，位于仓库的根目录之下 14 | 15 | 目录示例：[TOC.md](TOC.md) 16 | 17 | 3.点击对应的章节文件开始撰写内容 18 | 19 | 章节示例：[极客学院文案风格规范](copywriting-guide.md) 20 | 21 | ## 添加内容 22 | 23 | 1.**目录 TOC.md** 24 | 25 | ![](images/toc3.png) 26 | 27 | 2.**在对应的章节文件开始撰写内容** 28 | 29 | ![](images/toc4.png) 30 | 31 | ## 参考材料 32 | 33 | [Markdown 语法参考](markdown.md) 34 | 35 | [极客学院文案风格规范](copywriting-guide.md) -------------------------------------------------------------------------------- /start-writing.md: -------------------------------------------------------------------------------- 1 | # 第三步，撰写内容 2 | 3 | 示例： 4 | 5 | ## 参考材料（10分钟掌握） 6 | 7 | [Markdown 语法参考](markdown.md) 8 | 9 | ## 添加目录 10 | 11 | **目录 TOC.md** 12 | 13 | ![](images/write1.png) 14 | 15 | ## 添加新文件 16 | 17 | ![](images/new-file.png) 18 | 19 | **文件名：about-us.md** 20 | 21 | ![](images/content.png) 22 | 23 | ## 添加内容 24 | 25 | **在对应的章节文件开始撰写内容** 26 | 27 | 例如:选择 **关于极客学院** 28 | 29 | ![](images/write2.png) 30 | 31 | >提示：右上角的 ![](images/1.png) 是编辑按钮；![](images/2.png) 是删除按钮；![](images/3.png)是保存按钮。 32 | 33 | 当你撰写了一定章节的内容，想要查看在 Wiki 里面的展示效果时，那么你需要：[配置 Webhook](webhook-config.md) 34 | -------------------------------------------------------------------------------- /submit-online.md: -------------------------------------------------------------------------------- 1 | # 第五步 提交，上线 2 | 3 | ## 本地上传远程 4 | 5 | 当你创作整理完成后，可以去 GitHub 图形工具里面点击对应的项目，然后填写日志信息，就可以提交远程了。 6 | 具体操作看下图。 7 | 8 | ![](images/submit.png) 9 | 10 | ## 发送 SSH 地址 11 | 12 | ### 如何发送 SSH 地址 13 | 14 | SSH 地址：![](images/oper1.png) 15 | 16 | ### 邮件 17 | 18 | 你也可以将你的仓库 SSH 地址发送到邮箱 wiki@jikexueyuan.com。请按 “名字+SSH（或Http）” 的格式发送。 19 | 20 | 例如：**张三 `git@github.com:wenquan0hf/hibernate.git`** 21 | 22 | 23 | -------------------------------------------------------------------------------- /test.md: -------------------------------------------------------------------------------- 1 | # 第一章 简介 2 | 3 | 极客学院是目前国内最大的 IT 职业在线教育平台。 4 | 5 | ## Wiki 介绍 6 | 7 | ## Press 介绍 8 | 9 | ### Press 功能点 10 | 11 | ### Press 权限列表 -------------------------------------------------------------------------------- /toc-struct.md: -------------------------------------------------------------------------------- 1 | # 第三步 创建基础文件结构，开始撰写 2 | 3 | ## 创建基础文件结构 4 | 5 | 通过前两节的介绍，你已经有了一个远程仓库，一个本地的仓库，仓库里有一个 README.md 的文件。知道了 Markdown 的基本用法，下面让我们开始创建基本的文件结构，在本地仓库文件位置 `C:\Users\Administrator\Documents\GitHub\test`下添加如下图所示文件和文件夹。 6 | 7 | ![](images/toc.png) 8 | 9 | >注意：你的 GitHub 仓库的本地文件地址以克隆下来的地址为准。 10 | 11 | ### 文件目录详解 12 | 13 | - **cover/** - 存放 [官网首页](http://wiki.jikexueyuan.com/) 背景图片（图片由极客学院提供，后期整理上线时，编辑会添加） 14 | - background.png 或 background.jpg 15 | - logo.png 或 logo.jpg 16 | 17 | - **images/** - 存放图片（用到的图片文件都放在这） 18 | 19 | - **author.md** - 作者简介（选填） 20 | 21 | - **README.md** - 说明文档（**必须有**，默认 wiki 首页显示，相当于书籍的序） 22 | 23 | - **TOC.md** - 目录（**必须有**，该 wiki 的目录） 24 | 25 | - **config.json** - 书籍名称和介绍（选填） 26 | - "name": "书籍名称", 27 | - "introduction": "书籍内容简介。", 28 | 29 | ## 添加新文件 30 | 31 | 添加新文件，如下图： 32 | 33 | ![](images/toc1.png) 34 | 35 | >**重要** 36 | 上面的文件路径都是可以自定义配置的，具体配置方法见：[自定义参数](config.md) 37 | 38 | **在新建文件时，按照以下文件命名规范：** 39 | 40 | - Markdown 文件：英文小写（多个英文减号连接）； 41 | 正确：copywriting-guide.md 42 | 错误：copywriting_guide.md、copywritingGuide.md、CopywritingGuide.md、copywriting guide.md 43 | 44 | ## 在新文件上添加内容 45 | 46 | 1.目录 TOC.md 47 | 48 | ![](images/toc3.png) 49 | 50 | 2.在对应的章节文件开始撰写内容 51 | 52 | ![](images/toc4.png) 53 | 54 | 到此，你已经开始了创作整理的路程了，按照这样编写，我们还不能生成具有极客风格的书籍，下面一节，我们将讲解[极客学院文案风格指南](copywriting-guide.md)。 -------------------------------------------------------------------------------- /webhook-config.md: -------------------------------------------------------------------------------- 1 | # 第四步，配置 Webhook 2 | 3 | ## 为什么要配置 Webhook 4 | 5 | 为了能使您在 Github 上的任何更新都能与我们的在线内容同步，需要配置 Webhook 6 | 7 | ## 配置 Webhook 的步骤 8 | 9 | ### 1. Github 项目首页点击右侧 Settings 10 | 11 | ![webhook1](images/webhook1.png) 12 | 13 | ### 2. 点击左侧 Webhooks & Services 14 | 15 | ![webhook2](images/webhook2.png) 16 | 17 | ### 3. 点击 Add webhook 按钮 18 | 19 | ![webhook3](images/webhook3.png) 20 | 21 | ### 4. 输入 Github 密码 22 | 23 | ![webhook4](images/webhook4.png) 24 | 25 | ### 5. 将我们的 Webhook 地址粘贴到 Payload URL，Secret 留空 26 | 27 | **Webhook 地址: http://wiki.jikexueyuan.com/api/github** 28 | 29 | ![webhook5](images/webhook5.png) 30 | 31 | ### 6. 点击 Add Webhook 按钮，添加 Webhook 32 | 33 | ![webhook6](images/webhook6.png) 34 | 35 | ### 7. 添加完成 36 | 37 | ![webhook7](images/webhook7.png) 38 | 39 | 配置完 WebHook后，就能够上线了，下面[第五步，通知我们](inform-us.md) 40 | -------------------------------------------------------------------------------- /why-us.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/why-us.md -------------------------------------------------------------------------------- /wiki-show.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jikexueyuanwiki/guide/9f4198602573bfe351952f8480e7d9e54f14137a/wiki-show.md --------------------------------------------------------------------------------