教你在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

目录
相关文章
|
5月前
|
Apache 数据安全/隐私保护 Docker
【开源问答系统】GitHub 14.9k star 的开源问答引擎来了,三分钟搭建完成~~~
Apache Answer 是一款开源问答系统,助力团队将零散知识沉淀为结构化资产。支持 Docker 快速部署、插件扩展、权限控制与多语言,兼具高效搜索、投票排序与私有化部署能力,适用于技术社区、企业知识库与用户支持场景。
710 22
|
5月前
|
人工智能 JavaScript 前端开发
Github 2024-10-28 开源项目周报 Top15
本周GitHub热门项目涵盖Svelte、Open Interpreter、PowerShell等,涉及Web开发、AI助手、自动化工具等领域,Python、JavaScript为主流语言,展现开源技术活跃生态。(239字)
569 19
|
5月前
|
人工智能 JavaScript 前端开发
Github 2024-11-04 开源项目周报 Top14
本周GitHub热门项目涵盖屏幕截图转代码、网页监控、低代码开发等。Python与TypeScript主导,亮点项目包括AI生成代码工具、开源社交应用Bluesky及机器人框架LeRobot,展现AI与自动化技术的快速发展趋势。
314 15
|
5月前
|
缓存 自然语言处理 JavaScript
抓紧上车,别再错过啦, Github 开源后台管理平台,Naive UI !!!
naive-ui-pro 是基于 Vue3 + Vite + TypeScript 的免费开源中后台模板,主打“路由插件化架构”,将权限、页签、缓存等功能拆解为可插拔模块,像搭积木一样灵活组装。内置 14+ 插件、Pro Naive UI 组件库与丰富示例,支持移动端适配、多主题、国际化,MIT 许可,开箱即用,助力高效开发。
662 4
|
5月前
|
人工智能 JavaScript Docker
Github 2024-11-11 开源项目周报 Top15
本周GitHub热门项目涵盖多领域:Python与TypeScript领跑,包括屏幕截图转代码、本地文件共享、PDF处理、AI开发代理等。亮点项目如screenshot-to-code、LocalSend、OpenHands及Diagrams,兼具创新与实用性,广受开发者关注。
445 13
|
5月前
|
人工智能 算法 JavaScript
Github 2024-10-14 开源项目周报 Top14
本周GitHub热门项目共14个,Python项目占7席。涵盖算法实现、生成式AI、金融分析、目标检测等领域,包括TheAlgorithms系列、OpenBB金融平台、Ultralytics YOLO11、Manim动画框架等,展现开源技术多元发展态势。
214 8
|
5月前
|
人工智能 Rust JavaScript
Github 2024-10-07 开源项目周报 Top15
本周GitHub热门项目共15个,Python项目占比最高达7个。榜首为Python算法实现集合TheAlgorithms/Python,Star数超17万;其他亮点包括Godot游戏引擎、OpenBB金融平台、ToolJet低代码框架及新兴AI相关项目如Crawl4AI、Llama Stack等,涵盖游戏、金融、AI、理财等多个领域。
237 4
|
5月前
|
人工智能 Rust 算法
Github 2024-09-30 开源项目周报 Top15
本周GitHub热门项目揭晓:Python主导,AutoGPT居首,涵盖AI、编程、数学动画等领域,助力开发者探索前沿技术。
185 4
|
5月前
|
人工智能 JavaScript 前端开发
Github 2024-09-16 开源项目周报 Top14
本周GitHub热门项目涵盖Python、TypeScript、Go等语言,React居首。亮点包括微软PowerToys、Node版本管理器、AI证件照工具HivisionIDPhotos及端侧大模型MiniCPM等。
195 2
|
5月前
|
Rust JavaScript 安全
Github 2024-09-02 开源项目周报 Top13
本周GitHub热门项目涵盖AI、开发工具与开源替代品。包括Notion替代AppFlowy、Airtable替代NocoDB、云平台Coolify及可观察性平台OpenObserve等,涉及Python、TypeScript、Rust等语言,聚焦效率、隐私与自动化。
360 1