介绍

GitBook是一个基于Node.js的命令行工具,可使用 Github/Git和Markdown来制作精美的电子书,GitBook 并非关 Git的教程。

导出格式有PDF、HTML等,需要添加相应插件。

官网:https://www.gitbook.com


安装

安装npm

从网站 https://nodejs.org/en/download/ 上下载并安装

npm -v

查看是否安装成功。

安装gitbook

npm install -g gitbook-cli
gitbook -V

查看是否安装成功。

安装GitBook Editor

这是官方的一个客户端编辑器。可以不安装,直接在GitBook网站上编辑文档也是可以的。

下载地址:https://www.gitbook.com/editor

现在的版本是7.0.12,如果要切换到Markdown编辑器,右下角有个按钮,点击然后选择“Edit Markdown”即可使用Markdown编辑器。如果是旧的版本,


使用

直接使用

在页面上,直接点击“+New Book”,根据提示即可创建一本书,然后就可以进行编辑了。

可用editor编辑,也可以网站上直接编辑。

关联GitHub

GitHub:先在上GitHub创建一个仓库。

GitBook:然后在GitBook右上角的个人信息那里,点击“Account Settings”,在界面上选择“GitHub”这个Tab,找到“Integration”选项卡,有一个按钮“Install GitHub integration on this account”,点击,选择刚刚在GitHub创建的仓库即可。

注意:后续如果还需要继续做关联,在GitHub网站的Setting中的“Intalled GitHub Apps”,对GitBook进行配置即可。

GitBook:创建一个新书,然后点击setting,有一个GitHub选项卡,选择关联的GitHub仓库即可。

现在就可用editor编辑,也可以网站上直接编辑,还可以用GitHub进行管理了。


文件结构

除了README.md,还需要SUMMARY.md这个文件,这个是书的结构,如下:

# Summary
* 第一章
* [第一节](di-yi-zhang/di-yi-jie.md)
* [第二节](di-yi-zhang/di-er-jie.md)
* 第二章
* 第三章

文件夹“di-yi-zhang”跟SUMMARY.md都在根目录。

默认情况下,如果是直接在网页上编辑的,目录跟文件名都会是拼音,当然可以自己命名。


导出

导出HTML,会在_book文件夹下生成文件

gitbook build

如果是要导出PDF,ePub或者mobi格式的电子书时,需要安装Calibre电子书阅读/管理器和命令行工具,不然可能会报错“EbookError: Error during ebook generation: 'ebook-convert'”。

导出PDF

gitbook pdf

其他功能

https://chrisniael.gitbooks.io/gitbook-documentation/content/index.html

插件搜索地址:https://plugins.gitbook.com/

GitBook 使用的更多相关文章

  1. gitbook安装与使用之windows下搭建gitbook平台

    最近需要在GitBook中去阅读电子书 安装nodejs cnpm安装gitbook 解压书籍文件,并cd到书籍文件目录 gitbook serve 浏览器访问localhost:4000 先在win ...

  2. Gitbook简易教程

    简介 GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书.GitBook支持输出以下几种文档格式 静态站点:GitBook ...

  3. 局域网内利用gitlab,jenkins自动生成gitbook并发布(nginx)

    安装了GitBook,内网使用,没法用上gitbook的网页. 用gitbook serve只能展示一本书,而且也不利于长期维护. 于是使用gitlab,jenkins,和nginx配合gitbook ...

  4. GitBook制作电子书详细教程(命令行版)

    GitBook 是一款基于 Node.js 开发的开源的工具,可以通过命令行的方式创建电子书项目,再使用 MarkDown 编写电子书内容,然后生成 PDF.ePub.mobi 格式的电子书,或生成一 ...

  5. Open Source Cassandra Gitbook for Developer

    Just released an open source Cassandra Gitbook for developer. http://teddymaef.github.io/learncassan ...

  6. GitBook – 使用 GitHub 和 Markdown 制作书籍

    GitBook 是一个命令行工具(也是 Node.js 库),让你能够使用 GitHub/Git 和 Markdown 构建出美丽的编程书籍,可以包含互动的练习.GitBook 支持使用多种语言构建书 ...

  7. gitbook使用

    第一步:安装node.js 官方网址:https://nodejs.org/en/ 运行以下命令,确认是否安装成功 node -v 第二步:安装gitbook npm install -g gitbo ...

  8. 利用 Gitbook 生成文档中心站点

    经过一个多月,Bugtags 最近上线了自己的文档站点:docs.bugtags.com,在这里你可以找到 Bugtags 集成.使用相关的绝大部分问题. 在这之前我们使用的是第三方提供的帮助中心产品 ...

  9. 从gitbook将书籍导入到github中

    gitbook自己的导出工具经常出问题,可直接使用git. 从gitbook中clone下书 $ git clone https://git.gitbook.com/username/name_of_ ...

  10. Gitbook安装

    Gitbook安装 Gitbook是从NMP安装的,命令行: $ npm install gitbook -g 安装完之后,你可以检验下是否安装成功: $ gitbook -V 0.4.2 如果你看到 ...

随机推荐

  1. 哥哥我刚学的java---------数组插入法------------

    package charufa; public class Test02 { // 插入法(插入一个数字). public static void main(String[] args) { int[ ...

  2. html静态页面实现微信分享思路

    微信分享网页的时候,希望分享出来的链接是标题+描述+缩略图,微信开发代码示例里已提供了方法,但只适用于动态页面.由于dedecms是生成了静态文件,其实我想使用ajax获取jssdk参数也能也能实现微 ...

  3. 基本数据结构——堆(Heap)的基本概念及其操作

    基本数据结构――堆的基本概念及其操作 小广告:福建安溪一中在线评测系统 Online Judge 在我刚听到堆这个名词的时候,我认为它是一堆东西的集合... 但其实吧它是利用完全二叉树的结构来维护一组 ...

  4. 对java面向对象的初识

    我其实一直想写点东西练练自己文笔,今天写下这篇技术类型的文章也没有一个好的格式和章法,但万事开头难,那么就从面向对象开始. 我们大部分人都知道互联网软件的存在,时刻影响了我们的现实生活,那么面向对象的 ...

  5. Java设置Excel有效性

    XSSFWorkbook wb = new XSSFWorkbook(); XSSFSheet sheet = wb.createSheet("Excel"); String[] ...

  6. DirectFB 之 环境配置

    1. 准备 directFB下载地址:http://www.directfb.org/index.php?path=Main%2FDownloads 本人采用的版本是DirectFB-1.5.3.ta ...

  7. 一天精通MongoDB数据库

    什么是MongoDB ? MongoDB 是由C++语言编写的,是一个基于分布式文件存储的开源数据库系统. 在高负载的情况下,添加更多的节点,可以保证服务器性能. MongoDB 旨在为WEB应用提供 ...

  8. Pangolin学习

    0.1. 资料 0.2. 使用说明 0.3. HelloPangolin 0.4. Plot data with ros 0.1. 资料 泡泡机器人 github example opengl中摄像机 ...

  9. Nginx 反向代理&负载均衡

    1.反向代理 当我们请求一个网站时,nginx会决定由哪台服务器提供服务,就是反向代理. nginx只做请求的转发,后台有多个tomcat服务器提供服务,nginx的功能就是把请求转发给后面的服务器, ...

  10. Oracle12c多租户管理用户、角色、权限

    Oracle 数据库 12 c 多租户选项允许单个容器数据库 (CDB) 来承载多个单独的可插拔数据库 (PDB).那么我们如何在容器数据库 (CDB) 和可插拔数据库 (PDB)管理用户权限.背景: ...