云服务器 99 / 年,新老同享(可以99/年续费),开发者力荐特惠渠道,新客户在享受9折
阿里云推广

如何使用gitbook创建并且发布文档

  • 内容
  • 评论
  • 相关

1. Gitbook依赖node.js环境,需要先安装node.js这里不在累述。

2. 使用npm全局安装gitbookcli

npm install   -g   gitbook-cli

3. 安装成功之后输入 gitbook -V ,查看gitbook版本,输入完成后会自动安装Gitbook

CLI version: 2.3.2

Installing GitBook 3.2.3  这里会一直转呀转,如果你的node版本比较高,这里一般会报错。参考我的另外一篇文章去解决。解决完毕再次输入gitbook -V 一直提示安装成功。https://www.wlphp.com/?post=369

4. 初始化文档

Mkdir  /book       

Cd /book

gitbook  init

这时gitbook会初始化文档目录,在该目录下创建README.mdSUMMARY.md文件

README.md就是文档的说明文档,SUMMARY就是文档目录

之后的内容就是用markdown格式写文档,并且索引到目录内

5. 本地运行gitbook

gitbook   serve

服务器会自动启动,需要注意的是,Gitbook访问端口是4000,需要开放4000端口。可以localhost:4000去访问。根目录会生成_book文件夹里面就是构建好的 静态html文档。可以把这个发布到服务器。

6. 发布html

gitbook  build

这时候Gitbook会生成网页,存放在 _book 目录下,上gitbook一样都会生成静态文件,但是区别是不会本地起来一个端口运行。

本文标签:

版权声明:若无特殊注明,本文皆为《菜鸟站长》原创,转载请保留文章出处。

本文链接:如何使用gitbook创建并且发布文档 - https://wlphp.com/?post=390

发表评论

电子邮件地址不会被公开。 必填项已用*标注