Gitbook 生成开发文档

川长思鸟来 2022-11-05 11:48 133阅读 0赞

GitBook 是一个基于Node.js的命令行工具，所以要先安装[Node.js][]，安装成功后全局安装 GitBook

npm install -g gitbook-cli

使用 Gitbook，在你想要创建项目的目录内执行以下命令

gitbook init

执行完毕后，文件夹内会多两个文件，README.md（书籍的介绍在这个文件里），SUMMARY.md（书籍的目录结构在这里配置）  
![在这里插入图片描述][20210306113150988.png]  
在 SUMMARY.md 编写书籍目录，这里也可以借助可视化编辑工具[typora][]来编写页面，最后把源码复制到SUMMARY.md即可，复制后再次执行 gitbook init，会自动生成对应文件

# Summary
    
    * [Introduction](README.md)
    * [基础](readme.md)
    * [介绍](part1/README.md)
        * [介绍1](part1/1.md)
        * [介绍2](part1/2.md)
        * [介绍3](part1/3.md)
        * [介绍4](part1/4.md)
    * [实例](part2/README.md)
    * [属性](part3/README.md)
    * [测试](part4/README.md)

![在这里插入图片描述][20210306113403242.png]  
执行gitbook serve来预览，他会自动生成 \_book 静态资源文件，[本案例演示][Link 1]，我们可以使用 gitee 来部署静态页面，具体方法请[查看博客][Link 2]

gitbook serve

[Node.js]: https://nodejs.org/dist/v14.16.0/node-v14.16.0-x64.msi
[20210306113150988.png]: /images/20221023/88e9a3c4c5df4c2f956a2a9e83431090.png
[typora]: https://www.typora.io/
[20210306113403242.png]: /images/20221023/acce9458d24b4ef3931eeeaeedee513b.png
[Link 1]: http://tianmeng1603.gitee.io/gitbook/
[Link 2]: https://blog.csdn.net/weixin_44640323/article/details/114365575

发表评论取消回复

表情：

评论列表（有 0 条评论，133人围观）

还没有评论，来说两句吧...

相关阅读

相关【Django项目开发】自动生成接口文档（二）

文章目录一、安装第三方库drf-yasg2 二、注册到子应用INSTALLED\_APPS 三、配置路由 1、注意四、接口文档中展

我不是女神ヾ/ 2024年03月30日 09:49/ 0 赞/ 25 阅读

相关【GitBook】生成PDF

前提条件 `GitBook`生成`PDF`依赖`calibre` 安装calibre 官网下载: `https://download.calibre-ebo

古城微笑少年丶/ 2023年09月25日 17:17/ 0 赞/ 20 阅读

相关 gitbook编译报错gitbook\gitbook-plugin-fontsettings\fontsettings.js'

cd ~/.gitbook/versions/版本/lib/output/website/ vim copyPluginAssets.js 注释掉`112行`或者改为`

ゝ一纸荒年。/ 2023年06月22日 13:54/ 0 赞/ 105 阅读

相关 Gitbook 生成开发文档

GitBook 是一个基于Node.js的命令行工具，所以要先安装[Node.js][]，安装成功后全局安装 GitBook npm install -g gitbo

川长思鸟来/ 2022年11月05日 11:48/ 0 赞/ 134 阅读

相关 mock2easy环境搭建和gitbook文档自动生成

第一步先在服务器上准备node环境 yum -y install gcc make gcc-c++ openssl-devel wget 下载源码及解压：

╰半橙微兮°/ 2022年09月30日 03:40/ 0 赞/ 115 阅读

相关 Android开发工具：Git，Github，GitBook

[ 从0开始学习GitHub系列][_0_GitHub] 原文链接：[http://blog.csdn.net/column/details/13170.html][_0

Dear 丶/ 2022年07月11日 05:40/ 0 赞/ 190 阅读

相关 Xcode4自动生成注释和开发文档

Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达

忘是亡心i/ 2022年06月09日 07:24/ 0 赞/ 159 阅读

相关 gitbook专业的在选文档编辑工具

gitbook简单教程：[http://gitbook.zhangjikai.com/][http_gitbook.zhangjikai.com] 文档编辑工具下载地址：[

曾经终败给现在/ 2022年04月24日 08:22/ 0 赞/ 101 阅读

相关 mock2easy环境搭建和gitbook文档自动生成

第一步先在服务器上准备node环境 yum -y install gcc make gcc-c++ openssl-devel wget 下载源码及解压：

女爷i/ 2022年04月08日 09:20/ 0 赞/ 170 阅读

相关 win7下gitbook生成pdf

gitbook已经积累了很多大咖们的电子书，并且很多都是经典的，但是我们经常习惯看pdf的书，然而这些好的gitbook的电子书基本都已经出版了，然而基于版权的问题，在gith

快来打我*/ 2022年02月16日 01:11/ 0 赞/ 307 阅读