GitBook

　　GitBook 提供以下功能。

支持 markdown 语法
自动构建文档网站
丰富的插件来拓展网站，比如：搜索，代码高亮等
支持 git 进行文档项目管理

什么是 GitBook

　　GitBook 是一个文档编辑工具。它的功能类似金山的 WPS，微软的 Office 中的 Word 文档编辑工具。它可以用来写文档、建表格、插图片、生成 pdf 。虽然这些功能不一定有 WPS、Office 做得好，但是它可以用文档生成一个网站，让更多的人了解到你书写的内容。从此，不再为共享文档给他人后，如何时时同步而烦恼。实例效果如下：

GitBook 官网注册登录后，可在线创建、编辑和发布文档。线下提供离线编辑工具 GitBook Editor。但是本文档主要讲解的是，如何利用 GitBook 的命令行工具 gitbook-cli 来创建、预览及发布文档。

安装 gitbook-cli

NodeJs

　　安装 NodeJs 是因为我们要使用其提供的 npm 包管理工具来下载安装 gitbook-cli。从 NodeJs 官网下载最新版本安装即可（版本要求 V4.0.0 及以上）。

安装 gitbook-cli

　　运行以下命令进行安装

npm install gitbook-cli -g

gitbook init 项目初始化

　　首先新建如下目录结构

README.md 和 SUMMARY.md 是两个必须文件。
- README.md：是对书籍的简单介绍

鼎盛云开放平台 H5 接口文档

# Summary* [Introduction](README.md)
* [1、接口规则](chapter1/README.md)
    * [1.1、协议规则](chapter1/section1.1.md)
    * [1.2、公共参数](chapter1/section1.2.md)
    * [1.3、其它说明](chapter1/section1.3.md)
        * [1.3.1、其它说明](chapter1/section1.3.1.md)
* [2、用户](chapter2/README.md)
    * [2.1、手机号查询用户注册状态](chapter2/section2.1.md)
    * [2.2、用户注册-短信下发](chapter2/section2.2.md)
    * [2.3、用户注册-短信验证](chapter2/section2.3.md)
    * [2.4、验证交易密码](chapter2/section2.4.md)
    * [2.5、是否关联身份信息-手机号](chapter2/section2.5.md)
    * [2.6、设置账单日](chapter2/section2.6.md)

注意星号”*” 后面有个空格，忽略此会直接导致文档生成失败。

创建完这两个文件后，在文档根目录运行一下命令，初始化项目（gitbook 会帮我们生成 SUMMARY.md 中的目录结构）

gitbook init

gitbook serve 编辑预览

　　书籍目录结构创建完成以后，就可以使用命令 gitbook serve 来预览书籍了。打开浏览器，输入http://localhost:4000查看书籍效果。当然，文档的具体内容，就有待自己去添加了。建议使用 markdown 语法，这里为小白提供一个markdown 简单教程;

gitbook build 发布图书

　　通过执行 gitbook build 命令，gitbook 会在根目录下面生成一个编译打包后的文件 _book 里面便是我们文档编译后生成的 html 网页。后面便是，通过 ngnix 托管，让其在互联网上可见。

Glossary 词汇解释

　　词汇表文件，默认对应根目录下的 GLOSSARY.md 。该文件主要存储词汇信息，如果在其它页面中出现了该文件中的词汇，鼠标放在词汇上会给出词汇解释。
　　Glossary 文件的格式如下所示：

## API
接口说明文档## Markdown
排版语言，程序员专属

这里是两个 ## 。

book.json 文档配置信息说明文件

　　存放在根目录，记录文档项目的一些说明信息，及最后项目打包的配置信息。格式如下：

{title:"文档名称",author:"作者1;作者2",description:"文档描述",language:"使用的语言,英语、简体中国等",gitbook:">=3.2.2",  // gitbook 的版本root:".",// 指定存放 GitBook 文件的根目录links:"左侧边栏添加链接" ,styles:"指定打包生成网页的样式",plugins:"指定打包生成网页需要使用的插件",pluginsConfig:"配置插件的属性",
}

language

　　GitBook 使用的语言，简体中文配置如下：

"language":"zh-hans"

links

　　在左侧导航栏添加链接信息

"links":{"sidebar":{"Home":"http://localhost:4000"}
}

styles

　　自定义页面样式，默认情况下各 generator 对应的 css 文件

"styles":{"website":"styles/website.css","ebook":"styles/ebook.css",    "pdf":"styles/pdf.css","mobi":"styles/mobi.css","epub":"styles/epub.css",
}

plugins

　　配置使用的插件

"plugins":["disqus"
]

添加新插件之后，需要运行 gitbook installl 来安装新插件
GitBook 默认带有 5 个插件 highlight，search，sharing，font-settings，livereload。如果要去除自带的插件，可以在插件名称前面加 - 如下：

"plugins":["-search"
]

更多可选插件，可在插件官网查看。常见插件使用

pluginsConfig

　　配置插件的属性

"pluginsConfig":{"fontsettings":{"theme":"sepia","family":"serif""size":1}
}

GitBook 告别文档共享烦恼相关推荐

Confluence文档共享系统
Confluence文档共享系统转载于:https://www.cnblogs.com/cuiqq/p/10966967.html
自建latex服务器,快速部署支持 Makedown 和 LaTeX 等格式的 Zbox-Wiki 文档共享站点
快速部署支持 Makedown 和 LaTeX 等格式的 Zbox-Wiki 文档共享站点 Author: Poechant Blog: blog.CSDN.net/Poechant Email: z ...
全球与中国IHE XDS.B(跨企业文档共享)市场现状及未来发展趋势
本文研究全球及中国市场IHE XDS.B(跨企业文档共享)现状及未来发展趋势,侧重分析全球及中国市场的主要企业,同时对比北美.欧洲.中国.日本.东南亚和印度等地区的现状及未来发展趋势. 2021年全球 ...
Jitsi 开源视频会议远程桌面共享文档共享工具
1. 特点主要功能特点: 支持网络视频会议,使用SFU模式实现视频路由器功能. 支持SIP帐号注册电话呼叫. 支持安卓苹果终端. 支持文档共享功能,即时消息功能. 支持中文界面. 支持会议邀请,密码 ...
【BIEB六人行活动】解决文档共享难题的优化思路小结
2月份参加了BIEB六人行活动,有幸获得了月度大奖,非常感谢贝贝和michelle_it168,也非常荣幸能和好色如歌.Learnsql等众多网友一起讨论这个问题,从大家的发帖中也学习了很多东西.这里 ...
怎样把本地文档共享至服务器上,利用云服务器共享本地文件
利用云服务器共享本地文件内容精选换一换当您成功创建私有镜像后,镜像的状态为"正常",您可以使用该镜像创建服务器实例或云硬盘,也可以将镜像共享给其他帐号,或者复制镜像到其他区域 ...
计算机二级备考：Word 部分_3 表格长文档综合排版文档共享
三.表格创建表格快速创建基本表格:最多10行8列. 插入表格:下拉表格-插入表格,可以设置要插入表格的行列数,宽度(自动.固定值.根据内容自行调整--). 绘制表格:下拉表格-绘制表格,形式多样, ...
开源企业内部文档共享平台（mm-wiki）
Table of Contents 特点 Linux 平台安装 Windows 平台安装 Docker部署 https://github.com/phachon/mm-wiki MM-Wiki 是一个 ...
通过计算机名共享文档,共享文档
共享文档的图标上面有个手,局域网里可以通过网上邻居来访问别人电脑上的共享文档. 中文名共享文档外文名 Share documents学科网络工程领域工程技术共享文档创建方法 ...

GitBook 告别文档共享烦恼

GitBook

什么是 GitBook

安装 gitbook-cli

NodeJs

安装 gitbook-cli

gitbook init 项目初始化

gitbook serve 编辑预览

gitbook build 发布图书

Glossary 词汇解释

book.json 文档配置信息说明文件

language

links

styles

plugins

pluginsConfig

GitBook 告别文档共享烦恼相关推荐

最新文章

热门文章