进击的Python海南大学已收录(2017-8-15)

教你在Github写开源电子书

2018-04-15  本文已影响578人  zhaoolee

前段时间, 写了一篇从Github下载开源电子书, 收到很多赞, 有朋友问我, 如何写自己的开源电子书? 我在这里就详细的写一写...

前期准备:

  • 申请一个自己的github账户
  • 了解Markdown语法
  • 把文章读完的耐心 (我用了一整天写完, 读完大约需要10分钟)

写开源书分三步:

  • 在Github中建立一个仓库, 创建好书的目录
  • 通过Github授权登录Gitbook, 以Github仓库为源, 在Gitbook创建一本书
  • 在Gitbook中写文章, 然后将写作数据提交到Github仓库中

第一步: 在Github中建立一个仓库, 并创建好书的目录

新建仓库

新建仓库

建立仓库

建立仓库

添加新文件

添加新文件

建立目录

建立目录
# Summary
* [编者序](README.md)

滚动到页面底部, 点击Commit new file按钮

确认对SUMMARY.md的修改

第二步: 通过Gitbook连接Github仓库

进入 https://legacy.gitbook.com/, 使用github账户授权登录

SignUp

授权登录

授权登录

添加新书

添加新书

翻到下一页

翻到下一页

从Github导入

从Github导入

选择仓库

选择仓库

确认创建新书

创建书
创建成功, 可以动笔了!
开始编辑

第三步: 动笔写书

初始界面

初始界面

添加一篇文章

添加文章

切换到markdown编辑模式

切换到Markdown格式

切换后的界面

切换后界面

复制简书markdown格式文章

Gitbook简书 都支持Markdown, 我直接从简书拷贝一篇文章, 快速预览效果

拷贝

将复制的文章粘贴到gitbook编辑器

粘贴

效果预览

效果完美

将文章更新到Github

更新到Github

查看Github仓库, Github已经更新

Github已经更新

在线观看电子书

退出编辑器
开始阅读
阅读效果
页面效果切换

扩展: 可能你会遇到这些问题...

问题1: Gitbook无法关联到Github仓库

选择Settings
配置gitbook插件
保存修改

问题2: 文章的url是拼音, 有点low, 想改成英文

修改前
修改法则
修改
提交
修改后

福利: 给你开源项目的署名:

超级棒的"派神"书
最近我在编写开源的python书《超级棒的“派神”书》,如果有小伙伴, 愿意参与书的编写, 或者有好的建议,可以私信或留言,我会给在开源书的扉页为你添加署名的! 希望这本书尽快完成的小伙伴,可以给开源项目点个星哈! 开源项目在这里...
我的博客即将搬运同步至腾讯云+社区,邀请大家一同入驻:https://cloud.tencent.com/developer/support-plan?invite_code=37xtfq9gnbc4k
上一篇下一篇

猜你喜欢

热点阅读