如何使用gitbook创建文档web页面

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/l13620804253/article/details/89398003

1、先检查你是否安装有node.js;若没有,请先下载安装node.js。

2、进入cmd或powershell里,进入项目文件夹;然后npm install -g gitbook-cli     安装完可查看版本:gitbook -V;

3、执行完后,你会看到多了两个文件 —— README.md 和 SUMMARY.md,它们的作用如下:

4、用编辑器打开newbook文件夹(我用的vscode,随意选择,text也可以)

编辑 SUMMARY.md 文件,内容修改为:

目录会生成对应文件内容;

5、然后我们回到命令行,在项目文件夹中再次执行 gitbook init 命令。GitBook 会查找 SUMMARY.md 文件中描述的目录和文件,如果没有则会将其创建。

6、接着我们执行 gitbook serve 来预览这本书籍,浏览器访问localhost:4000

7、先将每个页面对应的内容写到相对应.md文件中(相关用到markdown语法,自己搜),写好后,你可以执行 gitbook build 命令构建书籍,默认将生成的静态网站输出到 _book 目录。实际上,这一步也包含在 gitbook serve 里面,因为它们是 HTML,所以 GitBook 通过 Node.js 给你提供服务了。 


当然,build 命令可以指定路径:
8、serve 命令也可以指定端口:gitbook serve --port 2333

Final:

_book中生成的HTML网页可以直接作为网站项目中的帮助中心或api文档,但里面的文件路径需要改动,以及左侧目录的最高层(最上级)路径也需要改动,还有部分样式问题也可以自己直接在生成的HTML中修改;

若觉得有用,请点赞!!!

展开阅读全文

没有更多推荐了,返回首页