文档章节

用 Github、Markdown 和 GitBook 写开源书

waylau
 waylau
发布于 2014/12/11 21:25
字数 575
阅读 10913
收藏 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

粉丝 491
博文 87
码字总数 160644
作品 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/
markdown 文档转 html 工具 - mddoc

mddoc 是一个开源的 markdown 文档转 html 文档工具,它使用 php 开发,支持 php >= 5.4。它生成的 html 可以直接放在网站上,支持全文搜索、自定义 html 模版。 mddoc 同时支持命令行、git...

宇润
06/27
0
0
使用Asciidoc代替Markdown和Word撰写开发文档

开发文档一般都由Word或Markdown(格式)撰写,前则多见于企业项目,后则在开源界很流行。但在实际使用中总觉得不尽人意。 他们的不是 Word的问题 表现上:格式过于复杂,导致写出来的文档排...

孤岛旭日
2015/10/30
0
0
Centos 7 下 GitBook 的安装与使用

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

羽杰
2017/09/21
0
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
0
requests+正则表达式 爬取 妹子图

  做了一个爬取妹子图某张索引页面的爬虫,主要用request和正则表达式。   感谢 崔庆才大神的 爬虫教学视频 和 gitbook:      B站:https://www.bilibili.com/video/av18202461/ind...

pertinence
04/24
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Bash重定向详解

Bash重定向详解 Bash的重定向指的是将命令的输入和输出导向不同地方,而不是默认的标准输入、标准输出和标准错误。Bash的重定向实际上是对标准输入、标准输出和标准错误的重置,进而将所需输...

小陶小陶
59分钟前
3
0
EventBus原理深度解析

一、问题描述 在工作中,经常会遇见使用异步的方式来发送事件,或者触发另外一个动作:经常用到的框架是MQ(分布式方式通知)。如果是同一个jvm里面通知的话,就可以使用EventBus。由于Event...

yangjianzhou
今天
6
0
OpenCV图像处理实例:libuv+cvui显示摄像头视频

#include <iostream>#include <opencv2/opencv.hpp>#define CVUI_IMPLEMENTATION#include <cvui.h>extern "C"{#include <uv.h>}using namespace std;#define WINDOW_NAM......

IOTService
今天
3
0
openJDK之JDK9的String

1.openJDK8的String 先来看下openJDK8的String的底层,如下图1.1所示: 图1.1 底层上使用的是char[],即char数组 每个char占16个bit,Character.SIZE的值是16。 2.openJDK9中的String 图2.1...

克虏伯
今天
3
0
UEFI 模式下如何安装 Ubuntu 16.04

作者:知乎用户 链接:https://www.zhihu.com/question/52092661/answer/259583475 来源:知乎 著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。 针对UEFI模式下安装U...

寻知者
今天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部