文档 - 分享一款内部文档管理工具GitBook

2019/03/09 Docs

分享一款内部文档管理工具GitBook

背景

由于之前都是把文档放在Google Drive上,写的文档什么格式的都有,找起来太乱了,也没个统一格式,最后规定内部文档所有的统一Markdown写,统一放到Gitbook上

Gitbook是什么?

Gitbook是一个命令行工具(node.js库), 使用Github/Git创建漂亮的图书。具体不多说明,官方也有说明

开始使用

安装NPM

#添加epel源,centos7
#国内阿里云镜像
wget -O /etc/yum.repos.d/epel.repo http://mirrors.aliyun.com/repo/epel-7.repo
#国外
yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

#安装npm
yum -y install nodejs

通过NPM安装gitbook


npm install -g gitbook-cli

#查看gitbook是否成功安装。
gitbook -V

gitbook基本用法

Gitbook需要2个基本文件:

  • README.md
  • SUMMARY.md

README.md是关于你的书的介绍,而SUMMARY.md中则包含了书目,即章节结构,它的格式大致是:

* [第1章](c1.md)
 * [第1节](c1s1.md)
 * [第2节](c1s2.md)
* [第2章](c2.md)
 * [第1节](c2s1.md)
 * [第2节](c2s2.md)

剩下的东西就很好理解了,你只需要编写相应章节即可。在编辑完README.md和SUMMARY.md后,你可以运行以下命令:

gitbook serve .

执行 gitbook serve命令后,会先编译书籍gitbook build ,并根据SUMMARY.md生成书的目录。所有生存的文件都保存在当前目录下的一个名为_book的子目录中。如果没有问题会打开一个 Web 服务器,默认监听 4000 端口。如果编译有问题,会抛出错误信息。

在地址栏输入:http://localhost:4000即可看到你的书页了。

  • 示例图

后续使用

可以使用nginx进行代理出来,Gitbook也支持各种插件,可以根据需求自行去探索

Search

    扫码加微信进入OpenDevOps群

    Yangxiaofei

    Table of Contents