1.什么是GitHub?
GitHub是一个软件源代码托管服务平台,用大白话说就是一个专门用于存放文件的“网盘”,只不过这个“网盘”是专门为开发者做的,帮助开发者存储和管理代码。目前这个平台汇集了超过5千万开发者。
我写了一个免费教程《图解SQL面试题》,想把它做成电子书放到GitHub,让更多人看到。
如果你也想使用GitHub制作电子教程,可以看我下面写的步骤。
2.如何制作电子教程?
1)在浏览器中安装插件
Github是用 Markdown语言来编写文档的,因此我们需要将公号的文档转化成 Markdown语言。
简悦是一个浏览器扩展,它能将网页转换成Markdown语言,官网地址:
http://ksria.com/simpread/
2)将文章转换成 Markdown文档
把公号文章链接复制到浏览器地址栏里打开,然后按照下图操作打开简悦,就可以把文章下载成 Markdown文件了。
3)将下载的 Markdown文件上传到 Github
登录 Github 建立章节,官网地址:
https://github.com/
点击右上角的 Sign in 按钮,填写账号密码登录,如果首次登陆需要先注册一个账号。
登陆后,先创建一个项目,然后点击项目名称进入项目。
点击 添加按钮(Add file),选择创建文件(Create new file) ,就进入创建文档页面了。
在下图红框的地方输入文件名称。如果需要创建电子书的章节,在输入的名称后加“/“即可自动创建章节。Github 不允许创建空白章节,所以在创建章节后还需输入文件名称。
填写完毕后,点击下图红框(提交修改)就可完成章节和文档的创建。如不需要文档后期删除该文档即可。
4)上传Markdown 文档
此时,章节已经创建好了。我们只需找到对应的章节把之前下载的 Markdown文件上传到对应章节。
点击 添加按钮(Add file),选择上传文件(Upload file)。
可以点击选择文件(Choose your files),将之前下载的 Markdown文件上传到GitHub。
一次可上传多个文档,上传成功后,点击下图红框的地方提交修改。
如何查看我们的操作是否成功呢?
点击对应章节名称,查看文档是否显示,如果显示就证明上传成功了。
5)对上传的 Markdown文件进行手动修改
前面插件工具转化后的 Markdown文件不一定完全符合我们的需要,因此还需进行手工修改。点击需要修改的 Markdown文件。
点击修改按钮(下图红框)
修改完后可以先可点击预览(Preview changes) ,查看有没有达到期待的效果。
可在下图灰色区域(下图红框)的地方记录这次修改的内容。修改结束后,点击提交修改( Commit changes) 。
6)修改书的目录
项目首页的README.md文件是电子书的目录,现在我们要把刚才上传的文档更新到目录中。
点击 README.md 的修改按钮。
将下面的代码段替换成需要插入的文件名称和文件相对地址,并放在对应的章节脚本位置下。
例如,[字节跳动面试题:你的平均薪水是多少?](./_chapter5_项目实战/字节跳动面试题:你的平均薪水是多少?.md)
Gitbub 是通过Commit 来记录修改内容及完成修改提交的,因此在每次修改后均需点击提交提交修改(Commit changes)来完成修改。
3.给电子书添加作者信息
在电子书目录的地方可以作者、电子书相关的图标和链接,效果如下。
如何添加和修改这些内容呢?
1)修改图标的顺序
假设需要将下图的 Stars 和作者的图标移动到箭头的地方,也就是这一行的末尾
点击 README.md文件右上方的修改按钮
找到文档开头处下图脚本位置,一个<< span="">a>的代码段就代表了一个图标。找到Stars和作者的图标代码(下图红框)移动到最后箭头所指的<< span="">a>代码后,点击提交完成修改。
2)修改图标对应链接
找到图标所在的代码段<< span="">a>里href 的值,将下图红框等号后的内容修改为想要的链接内容,点击提交完成修改。
4.最终成果
点击下图红框的地方,有越多人给Star,作品就可以被更多人看到,我的电子书成果地址:
https://github.com/houzidata/Graphical-SQL-interview-questions
https://zhuanlan.zhihu.com/p/368490849
https://zhuanlan.zhihu.com/p/369816457