文档章节

用 Github、Markdown 和 GitBook 写开源书

waylau
 waylau
发布于 2014/12/11 21:25
字数 575
阅读 11472
收藏 34

原文同步至:http://www.waylau.com/using-github-markdown-gitbook-write-open-source-books/

之前一直是在 Github 上写开源书(见:http://www.waylau.com/books/)但,由于 Github 本身的目录结构并不一定符合阅读的习惯,而且没有提供 pdf , ePUB, MOBI 等格式的转换下载。很多同学也还是习惯离线看文档。GitBook 就是解决这一问题。

GitBook 让你在保持在 Github 的书写习惯外,稍加配置,就能自动发布到GitBook 上,形成界面漂亮的电子书了(支持 html, pdf , ePUB, MOBI 等)。

<!-- more -->

如果你是第一次使用 GitBook,可以参见 使用 GitBook 写开源书

下面介绍,如果将一个 Github 项目转移到 GitBook 上来

##注册账户

需要拥有 GithubGitBook 的账户

##关联账号

将 GitBook 的项目关联上 Github 的库

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/09_zpsaeaf67fe.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/09_zpsaeaf67fe.jpg" border="0" alt=" photo 09_zpsaeaf67fe.jpg"/></a>

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/10_zpsedcdd57a.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/10_zpsedcdd57a.jpg" border="0" alt=" photo 10_zpsedcdd57a.jpg"/></a>

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/15_zps799c92ae.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/15_zps799c92ae.jpg" border="0" alt=" photo 15_zps799c92ae.jpg"/></a>

##原有的项目

这个是原来的项目结构,参见https://github.com/waylau/apache-shiro-1.2.x-reference

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/01_zpscf15bb6f.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/01_zpscf15bb6f.jpg" border="0" alt=" photo 01_zpscf15bb6f.jpg"/></a>

##添加 SUMMARY.md 文件配置

不改变原有的项目结构,添加 SUMMARY.md 文件,描述了 GitBook 目录结构,如下:

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/03_zpsc08a9a83.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/03_zpsc08a9a83.jpg" border="0" alt=" photo 03_zpsc08a9a83.jpg"/></a>

# 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 其他

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/02_zps4c051456.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/02_zps4c051456.jpg" border="0" alt=" photo 02_zps4c051456.jpg"/></a>

##编译

$ gitbook build ./

编译成功后,生成 _book 目录

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/04_zps2c62f5e9.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/04_zps2c62f5e9.jpg" border="0" alt=" photo 04_zps2c62f5e9.jpg"/></a>

##运行

运行 _book 目录 中 的index.html

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/05_zps05da7c9e.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/05_zps05da7c9e.jpg" border="0" alt=" photo 05_zps05da7c9e.jpg"/></a>

效果

<a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/06_zpsf5ef9805.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/06_zpsf5ef9805.jpg" border="0" alt=" photo 06_zpsf5ef9805.jpg"/></a>

##提交更新到 Github,自动发布到 GitBook

提交代码到 Github 的库,由于 GitBook 的项目关联上 Github 的库,所以 GitBook 会自动根据 Github 进行发布。 效果如下: <a href="http://s1288.photobucket.com/user/waylau/media/waylau%20blog/gitbook/16_zpsae785ba0.jpg.html" target="_blank"><img src="http://i1288.photobucket.com/albums/b484/waylau/waylau%20blog/gitbook/16_zpsae785ba0.jpg" border="0" alt=" photo 16_zpsae785ba0.jpg"/></a>

在线电子书:http://waylau.gitbooks.io/apache-shiro-1-2-x-reference/

© 著作权归作者所有

waylau

waylau

粉丝 552
博文 109
码字总数 190759
作品 2
深圳
架构师
私信 提问
加载中

评论(3)

waylau
waylau 博主

引用来自“金三胖”的评论

引用来自“waylau”的评论

擦~ 图怎么都挂了。可以看这里 http://www.waylau.com/using-github-markdown-gitbook-write-open-source-books/

你给的地址也打不开,在这里把图片补一下吧
可以打开啊,。多刷新几次,今晚上的服务器貌似有些不稳定
金三胖
金三胖

引用来自“waylau”的评论

擦~ 图怎么都挂了。可以看这里 http://www.waylau.com/using-github-markdown-gitbook-write-open-source-books/

你给的地址也打不开,在这里把图片补一下吧
waylau
waylau 博主
擦~ 图怎么都挂了。可以看这里 http://www.waylau.com/using-github-markdown-gitbook-write-open-source-books/
我用简书完成了Github 3K星的大项目

先放一张成果图 Github 3000星是一种什么水平? 下面两张数据统计时间为2019年4月5日 怎么做到的? 一年前, 我在简书新建了名为Chrome插件英雄榜的文集(文集名字中二? 星聚弃疗榜了解下, 嘿嘿~...

木子昭
2019/04/05
0
0
GitBook + github高效写书

比较建议直接在github上部署你的框架,然后再导入gitbook。 创建一个新的仓库 勾选创建一个readme文件,再点击红色框 create new file 创建一个新文件,名为SUMMARY.md,里面填入: 提交更改...

三也视界
2019/08/21
0
0
GitBook - 快速打造可留言的博客

Create by jsliang on 2019-05-20 14:43:41 Recently revised in 2019-05-22 18:01:09 本文将介绍如何安装 GitBook、如何起 GitBook 服务、如何配置 GitBook,以及到最后的部署到 GitHub Pag...

jsliang
2019/05/22
0
0
Gitbook-Ext 修改Gitbook模板

Gitbook-Ext GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 并非关于 Git 的教程。 GitBook 提供的的默认样式可能不能满足您的视觉...

漆工
2015/10/07
2.4K
0
docsify 不一样的文档工具

一、无规范不和谐 俗话说"无规矩不成方圆",但是我要说无规范不和谐,你可能觉得言重了「言重个毛」,下面就简单的说一下吧 公司没有规范可以吗「那不乱了套了」 人事招人没有规范可以吗「随...

TigerChain
2018/11/06
0
0

没有更多内容

加载失败,请刷新页面

加载更多

新海软件邮政市场监管综合信息平台

二、系统功能 该平台包括邮政普遍服务管理、快递管理两大系统,涵盖了地图定位、普服信息、快递信息、GIS管理、网格管理、视频监控、数据分析(BI)、系统设置等八大模块,全面反映了区域邮政...

neocean
昨天
165
0
【微记忆】用户隐私政策与条款

微记忆尊重并保护所有注册用户的个人隐私权。为了给您提供更准确、更贴心的服务,微记忆会按照本隐私权政策的规定储存并使用您的个人信息。微记忆承诺将以高度严格的审慎义务对待这些信息。除...

微记忆
昨天
69
0
两周自制脚本语言-第7天 添加函数功能

第7天 添加函数功能 基本的函数定义与调用执行、引入闭包使Stone语言可以将变量赋值为函数,或将函数作为参数传递给其他函数 有些函数将有返回值的归为函数,没有返回值的归为子程序 7.1 扩充...

果汁分你一半
昨天
105
0
让你的 Linux 命令骚起来

@[toc] 本文将为读者提供许多不同 Linux 命令的简要概述。 将特别强调解释如何在执行数据科学任务的上下文中使用每个命令。 我们的目标是让读者相信这些命令中的每一个都非常有用,并且让他们...

叉叉敌
昨天
112
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部