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

本文详细介绍如何使用GitBook创建和预览书籍,包括安装node.js、GitBook-cli,配置SUMMARY.md,以及通过gitbook serve命令预览和构建书籍。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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中修改;

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

lrz136

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值