微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

gitbook怎么编写产品文档并部署到云服务器中

本文小编为大家详细介绍“gitbook怎么编写产品文档并部署到云服务器中”,内容详细,步骤清晰,细节处理妥当,希望这篇“gitbook怎么编写产品文档并部署到云服务器中”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。

GitBook简介

GitBook 是一个基于 Node.js 的命令行工具,可以用来制作精美的电子书,一些互联网公司甚至已经使用 GitBook 来编写自己的产品文档和操作文档。功能强大,使用方便,用过都说好。

很多人疑惑 GitBook 是不是 Git 家族的相关产品,其实 GitBook 和 Git 的关系就像雷锋与雷峰塔的关系一样,没有半毛钱关系。

GitBook 可以使用 Markdown 编辑器来编写书籍,然后也可以使用 Github/Git 来维护和管理书籍版本,多人协同编写等。

制作出来的电子书可以支持输出多种文档格式。

GitBook安装部署在服务器上

首先根据服务器的操作系统下载 Node.js,下面我主要根据 CentOs 系统进行 Node.js 安装演示。

准备工作:

云服务器:编程之家云服务器;

操作系统:CentOs;
1、以 yum 方式安装 Node.js。

curl -sL https://rpm.nodesource.com/setup_10.x | bash -yum install -y nodejs

接下来看看是否安装成功。

[root@localhost /]# node -v
v12.16.0
[root@localhost /]# npm -v
6.13.4


2、安装 GitBook。

全局安装:npm install gitbook-cli -g 这个执行完毕之后,gitbook -v 可以查看到gitbook版本,就表示安装成功。

GitBook 有如下命令,常用到的有前面6个:

gitbook init //初始化目录文件
gitbook help //列出gitbook所有的命令
gitbook –help //输出gitbook-cli的帮助信息
gitbook build //生成静态网页
gitbook serve //生成静态网页并运行服务器
gitbook build –gitbook=2.0.1 //生成时指定gitbook的版本, 本地没有会先下载
gitbook ls //列出本地所有的gitbook版本
gitbook ls-remote //列出远程可用的gitbook版本
gitbook fetch 标签/版本号 //安装对应的gitbook版本
gitbook update //更新到gitbook的最新版本
gitbook uninstall 2.0.1 //卸载对应的gitbook版本
gitbook build –log=debug //指定log的级别
gitbook builid –debug //输出错误信息

创建 GitBook 电子书

进入想要创建电子书的目录执行 gitbook init 命令。

等待执行完成之后会在目录下生成 README.md 文件和 SUMMARY.md 文件,这两个文件可以使用 Markdown 编辑器进行编写。SUMMARY.md 文件里面主要写章节目录信息,README.md 文件里面主要写书籍内容

发布电子书
书籍编写完成之后 使用上面提到的 gitbook serve 命令将书籍生成静态网页并运行服务器。

另外,GitBook 在服务器运行需要开放 4000 端口。

通过配置好服务器的网络之后就能通过远程访问我们部署在服务器上的书籍了。

最后通过访问 http://编程之家服务器IP地址:4000 就可以看到自己的书籍了。

读到这里,这篇“gitbook怎么编写产品文档并部署到云服务器中”文章已经介绍完毕,想要掌握这篇文章的知识点还需要大家自己动手实践使用过才能领会,如果想了解更多相关内容文章,欢迎关注编程之家行业资讯频道。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 [email protected] 举报,一经查实,本站将立刻删除。

相关推荐