gitbook study

梦里梦外; 2023-01-21 04:28 17阅读 0赞

# gitbook #

*  说明

gitbook 是一个简单的个人在线书籍网站,在这里可以把自己的文档整理成书籍,**通俗来说,就是将分散的文档整理起来,整成一个电子书的样式**

*  参考地址
    
    [gitbook 教程][gitbook]

## 替换npm 的源 ##

在国内访问github ,maven ,npm 等都会很慢,因此可以将npm 的数据源换成淘宝的  
参考:[https://blog.csdn.net/weixin\_42349568/article/details/108414441][https_blog.csdn.net_weixin_42349568_article_details_108414441]

*  查看当前源站  
    `npm config get registry`
 *  设置新的源站为淘宝站  
    `npm config set registry https://registry.npm.taobao.org`
 *  在检查源是否切换成功  
    `npm config get registry`

## 步骤 ##

*  首先确保本机有node环境,没有则进行安装,然后用npm 执行下列命令 `npm install -g gitbook-cli`
 *  推荐的编辑工具 `gitbook editor(需要翻墙下载)`,`typora`
 *  gitbook 的使用
    
     *  **创建笔记文件夹**,先再对应的位置创建一个目录,进入该目录执行 `gitbook init`,该目录下会出现一个 README.md 和 SUMMARY.md (目录结构) 两个文件
     *  **写目录**,就是修改上面的 SUMMARY.md 文件 , 语法：中括号里是这个目录的名字，小括号里是路径。其实就是markdown 的链接的语法
        
         *  写完目录需要再次执行 `gitbook init` , Gitbook会查找SUMMARY.md中描述的目录和文件，如果没有则会创建
         *  写markdown 的语法就不在这里啰嗦了,

## 插件 ##

在gitbook中有很多有用的插件，但是使用起来会有一点麻烦，这里给大家讲解一下怎么用。  
大家想要用别的插件可以直接去npm上找，都有使用方法的  
gitbook的插件大部分都在npm上，可以访问npm官网查看搜索插件https://www.npmjs.com/

*  gitbook-plugin-summary  
    自动生成目录的插件
    
    1.  首先打开你笔记文件夹下的book.json文件，没有就自己创建一个
    2.  将以下代码复制进去
        
            {
            	"plugins": ["summary"]
            	}
    3.  打开命令行,在文件夹中执行命令 `gitbook install`
    4.  执行命令 `gitbook serve`,之前没有目录的,现在就有了
 *  安装插件说明
    
    1.  `book.json` 就是插件的配件文件, 上文中的 “plugins”: \[“summary”\] 就是指定了哪个目录插件
    2.  而 `gitbook install` 命令,就是据`book.json`文件的配置去安装插件

## 生成电子书 ##

写完文档后,可以用 `gitbook serve` 来预览电子书,会把 markdown 格式的文档转换 为 html 格式,并且笔记文件夹中会多出一个 `_book` 文件夹,里面就是html文件

*  导出为 pdf 格式,命令 `gitbook pdf`
 *  导出报 ebook-convert 错误
    
    出错: 导出报 `ebook-convert` 错误
    
     windows 系统 GitBook生成PDF、epub报错Error during ebook generation: ‘ebook-convert’ 乱码
    
    解决:可能是因为你没有安装calibre 或 安装了 calibre 但是没有配置环境变量导致
    
    下载地址:[calibre 腾讯软件中心][calibre] , [calibre 官网][calibre 1]
    
    参考:[https://blog.csdn.net/zhouvip666/article/details/90709591][https_blog.csdn.net_zhouvip666_article_details_90709591]

## 查看帮助 ##

`gitbook help`

[gitbook]: https://www.jianshu.com/p/0388d8bb49a7
[https_blog.csdn.net_weixin_42349568_article_details_108414441]: https://blog.csdn.net/weixin_42349568/article/details/108414441
[calibre]: https://pc.qq.com/detail/16/detail_1916.html
[calibre 1]: https://calibre-ebook.com/download_windows64
[https_blog.csdn.net_zhouvip666_article_details_90709591]: https://blog.csdn.net/zhouvip666/article/details/90709591