手把手教你使用,Gitbook简易使用教程

GitBook 是一个支持用 马克Down 编写文档的软件,帮助出口 HTML、PDF、eBook 格式文书档案。作为开垦者我们平时会用它来写一些手艺和接口文书档案。

自身想把本身的博客总结归结下,于是找到了 GitBook,多了贰个写博客地点,笔者把它做为博客的备份。花了两八日学习了 GitBook,这里记录下。此教程基于 Mac,Windows 也基本上适用。

简介

GitBook 是叁个依据 Node.js 的命令行工具,可利用 Github/Git 和 马克down 来创设精美的电子书。GitBook支持出口以下三种文档格式

  • 静态站点:GitBook私下认可输出该种格式

  • PDF:要求安装gitbook-pdf信任

  • eBook:须要安装ebook-convert

图片 1

正文选自《马克down 实用指南》 作者:毕小烦

GitBook 官网:

安装 Node.js

GitBook 是基于 Node.js 的命令行工具,下载安装 Node.js。

质量评定安装是不是成功:

$ node -v
v6.11.0

策动安装

在运用GitBook 在此以前, 大家须求先安装一些亟须的工具,Node.js、GitBook、GitBook Editor、Git版本调整器。

GitBook 是三个根据 Node.js 开拓的命令行工具,使用它能够很有益的保管电子书,GitBook 是眼下最风靡的开源书籍写作方案。

GitBook 是基于 Node.js 的命令行工具,需先下载安装 Node.js,检验是还是不是安装成功:

Gitbook 安装

Gitbook 是用 npm 安装的,命令行:

$ npm install -g gitbook-cli

检验安装是或不是中标:

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

立异最新版本:

$ gitbook update

卸载:

$ npm uninstall -g gitbook

Node.js

Node.js 是一个基于Chrome JavaScript 运转时确立的二个平台, 用来实惠地搭建火速的, 易于扩大的网络应用· Node.js 依据事件驱动, 非阻塞 I/O 模型变得轻量和便捷, 非常相符 run across distributed devices 的 data-intensive 的实时应用。

1、win下安装Node.js

直接到nodejs官方网站下载,轻松安装就可以,此处不再细述。

2、检测是或不是安装成功

node -v //显示v4.1.1

行使 GitBook 能够让创小编专一写作,自由的书写,不必太多的关怀内容排版、公布和版本管理等主题材料。

$ node -vv6.9.1

GitBook Editor

官方编辑器,下载 https://www.gitbook.com/editor ,大约如图:

图片 2

有关 GitBook Editor 怎么选择和挂号 GitBook 等步骤较简单,这里略。

GitBook

GitBook 是二个基于 Node.js 的命令行工具,可采取 Github/Git 和 马克down 来营造地道的电子书。通过Node.js命令安装GitBook

1、NMP安装Gitbook

npm install gitbook -g

2、安装gitbook CLI

想在系统上的别的地点的gitbook命令,需求设置“gitbook CLI”,试行以下命令

//安装命令
npm install -g gitbook-cli
//卸载命令
npm uninstall -g gitbook

3、核算下是或不是安装成功

gitbook -V //显示0.4.2

除去通过 GitBook 命令行管理电子书外,还足以在线(gitbook.com)只怕选择桌面编辑器 Gitbook Editor 来编排和治本电子书。

应用 npm 安装 GitBook,命令如下:

插件

Git

Git是一款免费、开源的遍布式版本调整系统,用中国“氢弹之父”捷高效地管理任何或小或大的类型。基本安装请点击安装教程。假设无需从GitHub更新书到地头再编写翻译,则足以不设置Git。

对于新手来讲,小编引入应用 Gitbook Editor 来编排和治本电子书,因为它集成了 GitBook 命令、马克down 编器和 Git 的功用,内容通过 Git 可与 gitbook.com / Gitlab / GitHub 同步,方便版本管理和集体通力合作。

$ npm install -g gitbook-cli

book.json

新建叁个 book.json 文件,能够配备网址音讯、在 plugins 和 pluginsConfig 字段增多插件等。

插件命名情势为:

gitbook-plugin-X: 插件;

gitbook-theme-X: 主题。

可以在 npmjs 或 GitBook 插件 直接搜索插件只怕核心。
book.json 内容大概如下:

{
"gitbook": "3.2.3",
"title": "吴小龙同學",
"description": "http://wuxiaolong.me/",
"author": "WuXiaolong",
"language": "zh-hans",
"links": {
"sidebar": {

}
},
"plugins": ["github",
"donate",
"splitter",
"anchor-navigation-ex",
"-sharing",
"sharing-plus",
"-highlight",
"prism"
],
"pluginsConfig": {
"sharing": {
"douban": false,
"facebook": false,
"google": false,
"hatenaBookmark": false,
"instapaper": false,
"line": false,
"linkedin": false,
"messenger": false,
"pocket": false,
"qq": false,
"qzone": false,
"stumbleupon": false,
"twitter": false,
"viber": false,
"vk": false,
"weibo": false,
"whatsapp": false,
"all": [
"weibo","qq","qzone","google","douban"
]
},
"github": {
"url": "https://github.com/WuXiaolong"
},
"donate": {
"wechat": "http://7q5c2h.com1.z0.glb.clouddn.com/wechatpay.JPG",
"title": "",
"button": "赏",
"wechatText": "微信打赏"
},
"anchor-navigation-ex": {
"associatedWithSummary":false,
"showLevel":true,
"multipleH1": true,
"mode": "float",

"pageTop": {
"showLevelIcon": false,
"level1Icon": "fa fa-hand-o-right",
"level2Icon": "fa fa-hand-o-right",
"level3Icon": "fa fa-hand-o-right"
}
},
"theme-default": {
"showLevel": true
},
"fontsettings": {
"theme": "white",
"family": "serif",
"size": 2
},
"prism": {
"css": [
"prismjs/themes/prism-tomorrow.css"
]
}
}

}

说明

  • github:添加 GitHub 图标;
  • Donate:增加赞美按键;
  • splitter:使左边栏的幅度能够轻松调解;
  • anchor-navigation-ex:增加Toc到左侧悬浮导航以致回到最上端按键;
  • theme-default:将 showLevel 设为 true, 就能够来得题近年来面包车型大巴数字索引,私下认可不彰显。

GitBookEditor

GitBook官方顾客端编辑器,扶持Win、Linux、Mac系统。请点击下载GitBookEditor。使用该编辑器能够长足的创导、编辑GitBook。安装具备以下步骤:

  • 解压下载包 gitbook-editor-4.2.1-windows-ia32.zip

  • 运作GitBook Editor Setup.exe实行暗中认可安装

基本使用

GitBook 大致分为三种采用方式,即离线和在线。最简便的运用方法是采取GitBook Editor编辑GitBook ,然后利用相关命令编写翻译成功HTML。当然还应该有以下两种格局

  • 应用命令成立基本GitBook

  • 运用网页在线编辑器创立、编辑GitBook。

  • 动用itBookEditor顾客端创立、编辑GitBook。

gitBookEditor

利用顾客端情势,援助在线和本土三种格局创制、编辑GitBook,再实行相关命令编写翻译成HTML,这种艺术相比相当低价,推荐应用。以本地创立书籍为例

1、gitBookEditor客户端基本选用

图片 3

图片 4

2、使用命令对曾经创建的Book举办编写翻译

找到必要编写翻译的图书所在目录,试行gitbook serve 命令,在本计算机的暗中认可路线为C:UsersQGYGitBookLibraryImportgitbooksimpletutorial,如图所示

图片 5

可对于程序员或熟习 Git 和 马克down 的人,小编更推荐应用 GitBook 命令行 Typora SourceTree 来编排和管制电子书。使用正规工具做专门的工作的事,比 Gitbook Editor 高效相当多。

检验是或不是安装成功:

设置插件

$ gitbook install ./

毫不忘记那步,根目录 node_modules 文件下能看到安装那多少个插件。

或独立安装插件:

$ npm install gitbook-plugin-anchor-navigation-ex --save

高档扩大

驾驭了“基本选取”,但有的时候想要gitBook更赏心悦目,只怕更合乎我们自个儿的急需,则经过book.json配置进行自定义、乃至安装一些常用的插件等。

GitBook 是开源的,地址:https://github.com/GitbookIO/gitbook

$ gitbook -VCLI version: 2.3.2GitBook version: 3.2.3

默许插件

GitBook 暗中同意带有5个插件:

highlight

search

sharing

fontsettings

livereload

假设要删减自带的插件,能够在插件名称前边加 -:

"plugins": [
"-search"
]

如果想布置直接在 pluginsConfig 配置。

Book.json配置

GitBook 在编写翻译书籍的时候会读取书籍源码顶层目录中的 book.js 或者book.json,这里以 book.json 为例,参考 GitBook 文书档案能够领略,book.json 扶助如下配置

 

{

    //样式风格配置格式
    "styles": {
        "website": "styles/website.css",
        "ebook": "styles/ebook.css",
        "pdf": "styles/pdf.css",
        "mobi": "styles/mobi.css",
        "epub": "styles/epub.css"
     },

    //插件安装配置格式

    "plugins": ["myplugin"],
    "pluginsConfig": {
        "myPlugin": {
            "message": "Hello World"
        }
     }    
}

GitBook 的功能:

新建目录 book,在该目录下进行如下命令进行起始化:

GitBook 输出

自定义插件扩张

插件是扩张GitBook功能最佳的主意。使得GitBook成效尤为强有力,比如,把数学公式展现协理,追踪回访使用谷歌解析,…以toggle-chapters插件为例
toggle-chapters 插件的效果与利益是私下认可只在目录导航中展现章的标题,而不会显得小节的题目,点击每一章大概每一节会展现当前章或节的子目录,假如有的话,但是还要会收起别的此前进行的章节。所以,个人认为不是那一个实用,因为那样子客商不能够不慢跳转到未有开展的章节!

一、寻找、安装插件情势

1、编辑器情势(没得逞)

图片 6

2、通过GitHub方式

www.plugins.gitbook.com

3、node.js命令格局

  • 暗中认可安装在以下门路

 

C:UsersQGYAppDataRoamingnpmnode_modules
  • 把插件文件夹复制到

 

npm install gitbook-plugin-toggle-chapters --save-dev

二、通过Book.json配置插件

 

"plugins": ["toggle-chapters"],
    "pluginsConfig": {
        "myPlugin": {
            "message": "Hello World"
        }
     }

本文永恒更新链接地址:http://www.linuxidc.com/Linux/2017-05/144344.htm

图片 7

  • 支持 Markdown 或 AsciiDoc 语法
  • 可导出静态站点或电子书(PDF、epub、mobi)
  • 支撑多语言
  • 可安装封面
  • 辅助变量、模板和模板承接
  • 有增加的插件
$ gitbook initwarn: no summary file in this book info: create README.md info: create SUMMARY.md info: initialization is finished

本土预览

跻身你的 GitBook 书籍目录,右击 - 服务 - 新建位于文件夹地点的极限窗口,输入命令行:

$ gitbook serve

下一场浏览器展开 http://localhost:4000 就能够预览了,control c 甘休。

GitBook 的工具组合:

该命令将会生成 README.mdSUMMARY.md 多个公文。在那之中 README.md 是对文书档案的简易介绍,能够用来作为封面,SUMMARY.md 是文档的目录结构。

输出静态网址

$ gitbook build

上述都会在书籍目录生成 _book,前面二个能实时预览。

  • Node.js:为了利用 npm 安装 GitBook,必供给先安装 Node.js。
  • GitBook 命令:基于 Node.js 开垦的命令行工具,用于成立和治本电子书。
  • 马克down:GitBook 使用 马克down 来写作,小编再也不用忧郁排版了。

也得以团结预先定义好 SUMMAKoleosY.md 中的目录结构,然后再用 init 命令初步化,程序将会依照我们的目录结构变化目录和文书,目录结构示例:

输出 PDF 文件

# Summary* [Introduction](README.md)* [Chapter1](chapter1/README.md) * [Section1.1](chapter1/section1.1.md) * [Section1.2](chapter1/section1.2.md)* [Chapter2](chapter2/README.md)

下载 Calibre

生成 PDF 文件信任于 ebook-convert,须要安装 Calibre;

  • Git:GitBook 使用 Git 管理写作内容,方便几人同盟和版本处理。

book 目录下实践如下命令,将会生成 HTML 文件并提供预览地址:

布署 Calibre 情形变量

什么样布署遭逢变量参照他事他说加以考察这里,在 .bash_profile 文件参与:

# Calibre
export PATH=/Applications/calibre.app/Contents/MacOS:$PATH

立异刚安顿的景况变量:

$ source .bash_profile

查看全数的配备路线:

$ echo $PATH
$ gitbook serveLive reload server started on port: 35729Press CTRL C to quit ...info: 7 plugins are installed info: loading plugin "livereload"... OK info: loading plugin "highlight"... OK info: loading plugin "search"... OK info: loading plugin "lunr"... OK info: loading plugin "sharing"... OK info: loading plugin "fontsettings"... OK info: loading plugin "theme-default"... OK info: found 1 pages info: found 0 asset files info: >> generation finished with success in 1.0s ! Starting server ...Serving book on http://localhost:4000

输出 PDF 文件

命令行:

$ gitbook pdf

就要根目录下生成了 book.pdf 文件

  • Github/Gitlab:跟代码同样,写作的内容可以托管在 Github 或 Gitlab 中。

在浏览器中开发 http://localhost:4000 就能够见到最初化的文书档案。

发布

图片 8

如图,GitBook Editor - Book - Repository Settings,设置要求上传的远程 git,能够是 GitBook,GitHub 等。

比方只需生成 HTML 文件实行 build 命令就能够,命令如下:

域名

  • gitbook.com:用于在线编写、发表和托管电子书的网址。
$ gitbook build

设置 GitBook 域名

YourBook - SETTINGS - Domains,如图:

图片 9

在 Domain for content 填入自个儿的域名,因为笔者已经 Github page 中安装了 Hexo 博客,因而这里用的子域名。

GitBook 的选取意况:

假使急需生成 PDF 文件,由于重视 ebook-convert,须求安装 Calibre,安装配备完结后,试行如下命令就可以:

配置 DNS

DNS 从前用的dnspod:

图片 10

分析类型选取CNAME,将域名指向二个域名,完结与被指向域名一样的访问效果,主机记录这里值为 book,也能够别的,那样深入分析后的二级域名叫 book
.wuxiaolong.me;记录值填写服务商提供的域名,这里填写 www.gitbooks.io。

注:最终自个儿仍然删了,因为笔者的域名未有备案,微信会有「非微信官方网页」提醒,蛋疼。

  • 搭建公司内部的文书档案平台,用于公司内部的材质共享。
  • 公布开源的电子书,用于在互联互连网共享本人的文化,普惠大众。
$ gitbook pdf

最后

1、提议采用 GitBook Editor 在线编辑,作者本地编辑老是崩溃,不知情是她们软件难点照旧本身计算机难点,在线编辑还应该有个好处,插件不用下载;

2、遗留八个难题未有化解,如图:

图片 11

第一问题:这里是自动生成的,我能改成其他地址吗? 已解决!

其次主题素材:发掘没,葡萄牙共和国语全部都以大写,能写什么就显得怎么吧?

望知道的同伴告知下,感激!

GitBook 情状布署

千帆竞发此前我们需求先安装:

  • nodejs
  • gitbook

今昔帮忙实时预览的 markdown 编辑器有广大,能够依附自身的喜好选择,此处仅做推荐:

参考

  • GitBook Document
  • Mac 下 GitBook 的装置与利用
  • gitbook-use
  • GitBook Clarity

安装 Node.js

因为 GitBook 是接纳 Node.js 开垦的,须要经过 Node.js 包管理工科具 NPM 安装,所以在早先以前要先把 Nodejs 安装好。

Node.js 下载地址:https://nodejs.org/zh-cn/

NPM(node package manager),平时堪称 node 包管理器。使用 NPM 能够对 node 包举行安装、卸载、更新、查看、搜索、宣布等操作。

安装完 Node.js,NPM 就能够直接用了。

  • 合法编辑器 GitBook Editor
  • PhpStorm(不要问作者干吗,笔者不会告诉你自身是 PHP 程序员)
  • Sublime Text(其实小编写 MD 文书档案都不要预览,所以没给它装插件,龇牙)

安装 GitBook

使用 NPM 安装 GitBook 的命令行工具:

$ sudo npm install gitbook-cli -g

安装到位后翻看 GitBook 的本子:

$ gitbook --version
CLI version: 2.3.0
GitBook version: 3.2.2

更新 GitBook命令:

$ npm update gitbook-cli -g

卸载 GitBook 命令:

$ sudo npm uninstall gitbook-cli -g

注意:

本例中动用的是全局安装 GitBook 命令,还会有一种安装格局是本土安装,二种方法有何区别呢?

  • 本地安装:安装包会被下载到当前所在目录,由此不得不在当前目录下利用。
  • 全局安装:安装包会被下载到到特定的系统目录下,安装包能够在享有目录下利用。

比如,查看 macOS 下全局安装被安装到了哪里?

$ which gitbook
/usr/local/bin/gitbook

GitBook 被安装到了 /usr/local/bin/ 目录下,由此能够全局使用。

本文选自《马克down 实用指南》 作者:毕小烦

由此布置 book.json 中的参数,咱们能够配备文书档案的累累音信,举例标题、侧边栏、插件等。四个差不离的 book.json 文件如下:

飞快早先 GitBook

{ "title": "GitBook 使用教程", "author": "Yanlong Ma <json_vip@163.com>", "description": "GitBook 使用教程 - 马燕龙个人博客", "generator": "site", "links": { "sidebar": { "马燕龙个人博客": "http://www.mayanlong.com" } }}

初始化 GitBook

# 创建 mygitbook 文件夹,并切换到这个文件夹下面
~$ mkdir mygitbook && cd mygitbook

# 初始化 gitbook 工作目录,创建必要的文件
~$ gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

下一场会开始化 GitBook 目录,创制多少个 md 格式的公文 README.md 和 SUMMA路虎极光Y.md

  • README.md - 项目标介绍都写在此个文件里。
  • SUMMARY.md - GitBook 的目录结构在这里处配置。

上面介绍的插件也亟需用到该配置。

概念目录结构

两种方法

在 SUMMA昂CoraY.md 文件中定义目录结构有两种艺术。

办法 ➊. 先定义好目录结构,通过 gitbook init 自动生成目录结构对应的公文夹和 马克down 文件。

方法 ➋. 先创建好文件夹和 马克down 文件再来编辑目录结构。

SUMMARY.md

SUMMA奥迪Q5Y.md 的目录结构长什么? 看上边:

# Summary

* [项目简介](README.md)
* [快速开始](docs/快速开始.md)
 * [环境搭建](docs/环境搭建.md)
 * [简单使用](docs/简单使用.md)
* [学入学习](docs/深入学习) 

那些目录建好今后在根目录下实施命令:

~$ gitbook init

那个从没的目录和文件都会被创制:

info: create docs/快速开始.md
info: create docs/环境搭建.md
info: create docs/简单使用.md
info: create docs/深入学习.md
info: create SUMMARY.md
info: initialization is finished

在乎: gitbook init 只扶植生成两级目录

GitBook 私下认可带有多个插件:highlight、search、sharing、fontsettings、livereload。假如要删减自带的插件,能够在插件名称前边加”-“,如下:

开首服务

在根目录试行命令:

~$ gitbook serve

结果:

Live reload server started on port: 35729
Press CTRL C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 5 pages
info: found 0 asset files
info: >> generation finished with success in 1.9s !

Starting server ...
Serving book on http://localhost:4000 # 注意浏览地址

执行 gitbook serve命令后,会先编写翻译书籍gitbook build,假若没不符合规律会打开一个Web 服务器,默许监听 伍仟 端口。假若编写翻译有毛病,会抛出错误新闻。

"plugins": ["-search"]

查看效果

用浏览器展开 http://localhost:4000/ 或 查看呈现书籍的功效。

图片 12

此间写图片描述

假设想发给外人看,把 localhost 换到温馨计算机的 IP 地址。

Tips:

Linux 上查看 IP 地址的通令是: ifconfig

Windows 上查看 IP 地址的一声令下是:ipconfig

正文选自《马克down 实用指南》 作者:毕小烦

图片 13

GitBook 还扶助广大插件,能够从 NPM 上追寻 GitBook 的插件,GitBook 推荐插件的命名格局如下,所以能够透过以下二种格局来查找 GitBook 的插件恐怕大旨:

gitbook-plugin-X: 插件gitbook-theme-X: 主题

下边介绍如何设置 gitbook-plugin-prism 插件,在 NPM 寻觅该插件,插件主页链接为

第一安装该插件,命令如下:

$ npm i gitbook-plugin-prism

接下来在 book.json 中加多该插件,同期禁止使用暗许的 highlight,配置如下:

{ "plugins": ["prism", "-highlight"]}

能够依附自个儿的喜好,配置分歧的核心:

"pluginsConfig": { "prism": { "css": [ "prismjs/themes/prism-solarizedlight.css" ] }}

本文首发于马燕龙个人博客,迎接分享,转发请评释出处。马燕龙个人博客:

本文由星彩网app下载发布于计算机编程,转载请注明出处:手把手教你使用,Gitbook简易使用教程

TAG标签: 星彩网app下载
Ctrl+D 将本页面保存为书签,全面了解最新资讯,方便快捷。