用 Github、Markdown 和 GitBook 写开源书
2023-09-14 08:59:41 时间
之前一直是在 Github 上写开源书(见:http://www.waylau.com/books/)但,由于 Github 本身的目录结构并不一定符合阅读的习惯,而且没有提供 pdf , ePUB, MOBI 等格式的转换下载。很多同学也还是习惯离线看文档。GitBook 就是解决这一问题。
GitBook 让你在保持在 Github 的书写习惯外,稍加配置,就能自动发布到GitBook 上,形成界面漂亮的电子书了(支持 html, pdf , ePUB, MOBI 等)。
如果你是第一次使用 GitBook,可以参见 使用 GitBook 写开源书
下面介绍,如果将一个 Github 项目转移到 GitBook 上来
将 GitBook 的项目关联上 Github 的库
![photo 09_zpsaeaf67fe.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/09_zpsaeaf67fe.jpg)
![photo 10_zpsedcdd57a.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/10_zpsedcdd57a.jpg)
![photo 15_zps799c92ae.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/15_zps799c92ae.jpg)
这个是原来的项目结构,参见https://github.com/waylau/apache-shiro-1.2.x-reference。
![photo 01_zpscf15bb6f.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/01_zpscf15bb6f.jpg)
不改变原有的项目结构,添加 SUMMARY.md 文件,描述了 GitBook 目录结构,如下:
![photo 03_zpsc08a9a83.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/03_zpsc08a9a83.jpg)
# Summary This is the summary of my book. * I. Overview 总览 * [1. Introduction 介绍](I. Overview 总览/1. Introduction 介绍.md) * [2. Tutorial 教程](I. Overview 总览/2. Tutorial 教程.md) * [3. Architecture 架构](I. Overview 总览/3. Architecture 架构.md) * [4. Configuration 配置](I. Overview 总览/4. Configuration 配置.md) * II. Core 核心 * [5. Authentication 认证](II. Core 核心/5. Authentication 认证.md) * [6. Authorization 授权](II. Core 核心/6. Authorization 授权.md) * III. Web Applications * IV. Auxiliary Support 辅助支持 * V. Integration 整合 * VI. Tools 工具 * VII. Index 目录 * VIII. Other 其他
![photo 02_zps4c051456.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/02_zps4c051456.jpg)
$ gitbook build ./
编译成功后,生成 _book 目录
![photo 04_zps2c62f5e9.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/04_zps2c62f5e9.jpg)
运行 _book 目录 中 的index.html
![photo 05_zps05da7c9e.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/05_zps05da7c9e.jpg)
效果
![photo 06_zpsf5ef9805.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/06_zpsf5ef9805.jpg)
提交代码到 Github 的库,由于 GitBook 的项目关联上 Github 的库,所以 GitBook 会自动根据 Github 进行发布。 效果如下:
![photo 16_zpsae785ba0.jpg](http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/16_zpsae785ba0.jpg)
在线电子书:http://waylau.gitbooks.io/apache-shiro-1-2-x-reference/
阿里开源SpringBoot全栈小册!Github已标星百万 对于Spring Boot,我们都知道他的设计初衷是解决Spring各版本配置工作过于繁重的问题,简化初始搭建流程、降低开发难度而出现的。可以说用Spring Boot开发,我们在配置上是不用花费太多时间的。
开源多年后,Facebook这个调试工具,再登Github热门榜 让许多工程师合作开发大型应用大多会面临一个挑战,通常没有一个人知道每个模块是如何工作的,这种技能会让开发新功能、调查Bug或优化性能变得困难,为了解决这个问题,Facebook创建并开源了Flipper,一个可扩展的跨平台的调试工具,用来调试 iOS 和 Android 应用。近日又双叒登上了Github热榜。
Github上热搜的Java开源商城项目合集,这个是真的好 mall-swarm是一套微服务商城系统,采用了 Spring Cloud Hoxton & Alibaba、Spring Boot 2.3、Oauth2、MyBatis、Docker、Elasticsearch等核心技术,同时提供了基于Vue的管理后台方便快速搭建系统。mall-swarm在电商业务的基础集成了注册中心、配置中心、监控中心、网关等系统功能。文档齐全,附带全套Spring Cloud教程。 其它的先不说,一起来看看运行效果,首先是注册中心注册服务信息:
造孽啊!阿里内部的神级项目和JDK源码阅读指南竟惨遭GitHub开源 今天逛GitHub,发现了一个神级项目,作者将整理/记录阅读JDK源码时的理解与体会分享出来,便于大家学习。这里将项目分享出来,让小伙伴们能更好地学习Java。
同程内网流传的分布式凤凰缓存系统手册,竟遭GitHub强行开源下载 什么是分布式缓存? 分布式缓存能够处理大量的动态数据,因此比较适合应用在Web 2.0时代中的社交网站等需要由用户生成内容的场景。从本地缓存扩展到分布式缓存后,关注重点从CPU、内存、缓存之间的数据传输速度差异也扩展到了业务系统、数据库、分布式缓存之间的数据传输速度差异。 今天给大家分享的是一本从大型互联网大厂系统角度探讨分布式系统的手册,从原理、框架、架构、案例等多个视角对分布式缓存进行了探讨
相关文章
- GitHub 近两万Star,无需编码,可一键生成前后端代码,这个开源项目JeecgBoot有点强
- Windows下解决github push failed (remote: Permission to userA/XXXX.git denied to userB.) 上传gitHub失败报错
- APICloud Github 5大开源项目集合展示
- 首个接入 GPT-4,曾经比 GitHub Copilot 还好用的代码编辑器开源了!
- 在eclipse中使用github进行代码的上传操作以及如何建立分支
- 28款GitHub最流行的开源机器学习项目(一):TensorFlow排榜首
- 一不小心,它成为了 GitHub Alibaba Group 下 Star 最多的开源项目
- GitHub 标星 11000+,阿里开源的微服务组件如何连续 10 年扛住双十一大促?
- 基于redis的分布式缓存disgear开源到github上了
- 使用github管理Eclipse分布式项目开发
- 【学习总结】Git学习-上传本地已有代码到GitHub
- Android开源项目分包方式学习(eoe、oschina、github)
- go语言项目如何引用依赖Github上的开源项目
- git本地下载github上的某项目的部分资源
- 如何在 Github 工作流文件里引用自定义实现的 action
- github网站证书里的别名
- 什么是Github的元数据metadata以及如何备份github上的数据
- 如何修改Github已经提交的commit里的提交者用户名和提交者邮箱
- 一文教会你 如何在Github中创建仓库?如何将多个项目放到一个仓库中管理?如何将本地项目上传到GitHub中?
- 【Github教程】史上最全github用法:github入门到精通
- GitHub 优秀的 Android 开源项目
- github用相对路径显示图片_GitHub 中 readme 如何添加图片
- Windows下一个AndroidStudio 正在使用Git(AndroidStudio工程GitHub关联)
- 【Github教程】史上最全github用法:github入门到精通
- Github上的python开源项目
- 在HBuilderX的git上导入github项目/把项目传到github
- 使用在线的vscode打开github项目
- 简单几步-新项目添加到github
- 首次将IDEA中的项目上传到Github / Share Project on GitHub
- [Git & GitHub] 解决办法:error: failed to push some refs to 'https://github.com/xxxx.git'