文档章节

用 Github、Markdown 和 GitBook 写开源书

waylau
 waylau
发布于 2014/12/11 21:25
字数 575
阅读 10811
收藏 34
点赞 5
评论 3

原文同步至: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

粉丝 466
博文 83
码字总数 158407
作品 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/
Centos 7 下 GitBook 的安装与使用

文前说明 作为码农中的一员,需要不断的学习,我工作之余将一些分析总结和学习笔记写成博客与大家一起交流,也希望采用这种方式记录自己的学习之旅。 本文仅供学习交流使用,侵权必删。 不用...

羽杰 ⋅ 2017/09/21 ⋅ 0

ASP.NET Core MVC 和 Entity Framework Core 入门教程

前言 本文翻译自:Getting started with ASP.NET Core MVC and Entity Framework Core using Visual Studio 示例应用程序是虚构的Contoso大学的网站, 包括学生入学,课程创建和教师任务等功...

程序员长春 ⋅ 2017/10/12 ⋅ 0

PHPer 必知必会的 Linux 命令

PHPer 必知必会的 Linux 命令https://github.com/Nick233333/gitbook

-Nick- ⋅ 06/08 ⋅ 0

如何入门微信小游戏开发,有哪些学习资料?

开发微信小游戏并非难事 1.首先,微信小游戏的开发方法 可以看到微信游戏的开发方式 答主有一些COCOS的开发经验,于是这里我们主要探讨COCOS制作小游戏的方法 2.需要学习什么 JS(JavaScrip...

qq_40126542 ⋅ 05/05 ⋅ 0

类似gitbook的wiki选择

一直以来,都使用xwiki作为团队内部的文档管理工具,但一直想换一个比较轻量级的系统。团队成员普遍对gitbook风格有好感,于是先后试用了mdwiki、dokuwiki、hexo、mindoc、wikitten。 mdwiki...

ankexun ⋅ 04/13 ⋅ 0

Angr实例分析——fauxware

本博客由闲散白帽子胖胖鹏鹏胖胖鹏潜力所写,仅仅作为个人技术交流分享,不得用做商业用途。转载请注明出处,未经许可禁止将本博客内所有内容转载、商用。 在阅读Angr的gitbook的时候,作者超...

zhuzhuzhu22 ⋅ 05/24 ⋅ 0

进击的皇虫/converter

目录 缘由 安装calibre 文档导出效果 快速体验 使用案例 配置文件 json配置示例 json配置项说明 使用教程 Go语言使用 其它语言 原理 注意事项 精神上支持我 markdown文档如何转成pdf、epub、...

进击的皇虫 ⋅ 04/19 ⋅ 0

用github写开源书籍

用github写开源书籍 gitbook http://blog.csdn.net/hk2291976/article/details/51173850 用github写书籍 创建一个新的仓库 创建新文件,SUMMARY.md 创建一个新文件,名为SUMMARY.md,里面填入...

tantexian ⋅ 2016/10/25 ⋅ 0

几款好用的Markdown 写作工具推荐(下)

点击上方蓝色字体,关注我们 15 Markdown写作工具推荐 作业部落 Cmd Markdown 作业部落作为一款诞生较早(2014 年)的国产 Markdown 写作工具,支持 Windows、macOS、Linux 三大平台,其主要...

micf435p6d221ssdld2 ⋅ 05/12 ⋅ 0

Vue-cli 脚手架的安装与使用(详细说明)

1.1.1.1 安装Node.js 无疑Node.js是前端编程的必备环境配置之一。 安装过程非常简单,与平时安装的一般软件无异。 官方网站:https://nodejs.org/en/ Node.js自带npm包管理工具,使用npm可使...

weir_will ⋅ 04/05 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

从 Confluence 5.3 及其早期版本中恢复空间

如果你需要从 Confluence 5.3 及其早期版本中的导出文件恢复到晚于 Confluence 5.3 的 Confluence 中的话。你可以使用临时的 Confluence 空间安装,然后将这个 Confluence 安装实例升级到你现...

honeymose ⋅ 16分钟前 ⋅ 0

用ZBLOG2.3博客写读书笔记网站能创造今日头条的辉煌吗?

最近两年,著名的自媒体网站今日头条可以说是火得一塌糊涂,虽然从目前来看也遇到了一点瓶颈,毕竟发展到了一定的规模,继续增长就更加难了,但如今的今日头条规模和流量已经非常大了。 我们...

原创小博客 ⋅ 今天 ⋅ 0

MyBatis四大核心概念

本文讲解 MyBatis 四大核心概念(SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession、Mapper)。 MyBatis 作为互联网数据库映射工具界的“上古神器”,训有四大“神兽”,谓之:Sql...

waylau ⋅ 今天 ⋅ 0

以太坊java开发包web3j简介

web3j(org.web3j)是Java版本的以太坊JSON RPC接口协议封装实现,如果需要将你的Java应用或安卓应用接入以太坊,或者希望用java开发一个钱包应用,那么用web3j就对了。 web3j的功能相当完整...

汇智网教程 ⋅ 今天 ⋅ 0

2个线程交替打印100以内的数字

重点提示: 线程的本质上只是一个壳子,真正的逻辑其实在“竞态条件”中。 举个例子,比如本题中的打印,那么在竞态条件中,我只需要一个方法即可; 假如我的需求是2个线程,一个+1,一个-1,...

Germmy ⋅ 今天 ⋅ 0

Springboot2 之 Spring Data Redis 实现消息队列——发布/订阅模式

一般来说,消息队列有两种场景,一种是发布者订阅者模式,一种是生产者消费者模式,这里利用redis消息“发布/订阅”来简单实现订阅者模式。 实现之前先过过 redis 发布订阅的一些基础概念和操...

Simonton ⋅ 今天 ⋅ 0

error:Could not find gradle

一.更新Android Studio后打开Project,报如下错误: Error: Could not find com.android.tools.build:gradle:2.2.1. Searched in the following locations: file:/D:/software/android/andro......

Yao--靠自己 ⋅ 昨天 ⋅ 0

Spring boot 项目打包及引入本地jar包

Spring Boot 项目打包以及引入本地Jar包 [TOC] 上篇文章提到 Maven 项目添加本地jar包的三种方式 ,本篇文章记录下在实际项目中的应用。 spring boot 打包方式 我们知道,传统应用可以将程序...

Os_yxguang ⋅ 昨天 ⋅ 0

常见数据结构(二)-树(二叉树,红黑树,B树)

本文介绍数据结构中几种常见的树:二分查找树,2-3树,红黑树,B树 写在前面 本文所有图片均截图自coursera上普林斯顿的课程《Algorithms, Part I》中的Slides 相关命题的证明可参考《算法(第...

浮躁的码农 ⋅ 昨天 ⋅ 0

android -------- 混淆打包报错 (warning - InnerClass ...)

最近做Android混淆打包遇到一些问题,Android Sdutio 3.1 版本打包的 错误如下: Android studio warning - InnerClass annotations are missing corresponding EnclosingMember annotation......

切切歆语 ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部