教你在Github写开源电子书

简介: 前段时间, 写了一篇从Github下载开源电子书, 收到很多赞, 有朋友问我, 如何写自己的开源电子书? 我在这里就详细的写一写...前期准备:申请一个自己的github账户了解Markdown语法把文章读完的耐心 (我用了一整天写完,...

前段时间, 写了一篇从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

目录
相关文章
|
21天前
|
SQL JavaScript 前端开发
Github 2024-08-05 开源项目周报 Top15
根据 Github Trendings 的统计,本周(2024年8月5日统计)共有15个项目上榜。以下是根据开发语言汇总的项目数量: - Go 项目:4个 - JavaScript 项目:3个 - Python 项目:3个 - Java 项目:2个 - TypeScript 项目:2个 - C 项目:1个 - Shell 项目:1个 - Dockerfile 项目:1个 - 非开发语言项目:1个
28 2
|
21天前
|
人工智能 Rust JavaScript
Github 2024-08-26 开源项目周报Top15
根据Github Trendings的统计,本周共有15个项目上榜。以下是按开发语言汇总的项目数量:Python项目8个,TypeScript、C++ 和 Rust 项目各2个,Jupyter Notebook、Shell、Swift 和 Dart 项目各1个。其中,RustDesk 是一款用 Rust 编写的开源远程桌面软件,可作为 TeamViewer 的替代品;Whisper 是一个通用的语音识别模型,基于大规模音频数据集训练而成;初学者的生成式人工智能(第2版)则是由微软提供的18门课程,教授构建生成式AI应用所需的知识。
50 1
|
21天前
|
Rust Dart 前端开发
Github 2024-08-19 开源项目周报Top15
根据Github Trendings的统计,本周(2024年8月19日统计)共有15个项目上榜。按开发语言分类,上榜项目数量如下:Python项目最多,有7项;其次是JavaScript和TypeScript,各有3项;Dart有2项;HTML、PowerShell、Clojure和C++各1项。此外,还介绍了多个热门项目,包括Bootstrap 5、RustDesk、ComfyUI、易采集、Penpot等,涵盖了Web开发、远程桌面、自动化测试、设计工具等多个领域。
58 1
|
21天前
|
JavaScript 前端开发 Go
Github 2024-08-12 开源项目周报 Top14
本周Github Trendings共有14个项目上榜,按开发语言汇总如下:Python项目7个,TypeScript项目5个,C项目2个,JavaScript项目2个,Go和Batchfile项目各1个。其中亮点包括开发者职业成长指南、Windows激活工具、ComfyUI图形界面、AFFiNE知识库、易采集可视化爬虫等项目,涵盖多种实用工具和开源平台。
44 1
|
21天前
|
存储 JavaScript 前端开发
Github 2024-07-29 开源项目周报Top15
根据 Github Trendings 的统计,本周(2024年7月29日统计)共有15个项目上榜。按开发语言分类,项目数量如下:Python、Java、HTML 和 C 项目各有2项;TypeScript、JavaScript、Vue 和 Go 各有1项;另有1项非特定语言项目、1项 Dart 项目、1项 C++ 项目、1项 Rust 项目及1项 Jupyter Notebook 项目。这些项目涵盖了多种领域,如API开发、照片管理、PDF处理、AI技术等。
35 1
|
21天前
|
Rust JavaScript 前端开发
Github 2024-07-15 开源项目周报 Top15
根据 Github Trendings 的统计,2024年7月15日当周共有15个项目上榜。以下是按开发语言分类的项目数量汇总:Python项目5个,非开发语言项目4个,JavaScript项目3个,TypeScript项目2个,Go、Solidity和Java项目各1个,Rust项目1个。此外,介绍了多个值得关注的项目,包括免费编程学习平台 freeCodeCamp.org、免费编程书籍和学习资源清单、免费 API 集合等,涵盖了不同编程语言和技术领域。
36 1
|
21天前
|
人工智能 JavaScript API
Github 2024-07-08 开源项目周报 Top15
根据Github Trendings的统计,本周(2024年7月8日统计)共有15个项目上榜。按开发语言分类,Python项目最多,有6项;其次是C++和TypeScript,各有3项;Jupyter Notebook和JavaScript各2项;QML、非开发语言项目、Rust则各有1项。这些项目涵盖了多种领域,包括编程教育、API集合、语言模型、十六进制编辑器等。
36 1
|
21天前
|
人工智能 JavaScript Shell
Github 2024-06-10开源项目周报 Top15
根据Github Trendings的统计,本周(2024年6月10日统计)共有15个项目上榜。按开发语言分类,上榜项目数量如下:Python 8项,Jupyter Notebook 和 Go 各2项,C++、Shell、Lua 和 JavaScript 各1项。亮点项目包括Python-100天从新手到大师、Syncthing开源同步工具、初学者的生成式人工智能(第2版)等。这些项目涵盖了代码教育、文件同步、数据分析等多个领域。
34 1
|
21天前
|
机器学习/深度学习 Rust JavaScript
Github 2024-06-24 开源项目周报 Top15
根据Github Trendings的统计,本周(2024年6月24日统计)共有15个项目上榜。按开发语言分类,项目数量如下:JavaScript项目5个,Python项目5个,TypeScript项目2个,Go项目2个,Dockerfile项目1个,C#项目1个,Java项目1个,Jupyter Notebook项目1个,Rust项目1个,Dart项目1个,Tcl项目1个。
29 0
|
21天前
|
JavaScript 前端开发 机器人
Github 2024-06-17 开源项目周报 Top15
根据Github Trendings的统计,本周(2024年6月17日)共有15个项目上榜。按开发语言分类,Python项目最多,达6项;TypeScript和JavaScript各有3项;PHP、Blade、Lua、Dart及非开发语言项目各1项。这些项目涵盖从零构建技术、智能家居、高性能数据库到情感语音模型等多个领域,体现了开源社区的多样性和创新力。
33 0