使用gitee+gitbook搭建个人在线电子书

GitBook是一个简单的个人在线书籍网站,在这里可以把自己的文档整理成书籍发布出来,便于阅读,现在使用gitee+gitbook搭建个人在线电子书!

官方示例:https://blog.gitbook.com/

搭建环境

git node.js gitbook Gitee Pages

搭建步骤

  1. 配置好本地Git环境

  2. 安装node.js,可在cmd输入node查看是否安装成功

  3. 使用码云Gitee(与Github类似),新建仓库,开启Gitee Pages服务,master分支放HTML文件,新建book分支放源码

  4. gitbook 环境搭建

1.安装gitbook
npm install -g gitbook-cli
gitbook -V

2.创建目录
mkdir gitbook
cd gitbook
gitbook init

3.启动gitbook服务,可以在浏览器查看
gitbook serve

4.生成项目静态网页,"_book"目录
gitbook build

5.安装gitbook插件
gitbook install

6.成 PDF 格式的电子书
gitbook pdf ./ ./mybook.pdf

使用报错

gitbook -V安装报错

C:\Users\Admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287
      if (cb) cb.apply(this, arguments)
                 ^

TypeError: cb.apply is not a function

解决方案

注释C:\Users\Admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js

// fs.stat = statFix(fs.stat)
// fs.fstat = statFix(fs.fstat)
// fs.lstat = statFix(fs.lstat)

Gitbook结构介绍

# gitbook init后生成文件树

├── node_modules
├── book.json (配置数据 (optional))
├── README.md (电子书的前言或简介 (required))
├── SUMMARY.md (电子书目录 (optional)) 
├── GLOSSARY.md (词汇/注释术语列表 (optional)) 

优化Gitbook

在gitbook中有很多有用的插件,可以进行美化页面,但是使用起来会有一点麻烦,这里仅讲解如何使用,gitbook的插件大部分都在npm上,可以访问npm官网自行查看并搜索插件。

npm官网:https://www.npmjs.com/

演示安装gitbook-plugin-summary的方法

插件:gitbook-plugin-summary (自动生成目录)
安装步骤:
1.打开gitbook根文件夹下的book.json文件,若没有就创建此文件
2.将以下代码复制进去
{
  "plugins": ["summary"]
}
3.打开命令行,在这个文件夹中执行命令`gitbook install`安装插件,执行命令`gitbook serve`,
然后在查看的时候就会发现,之前明明没有写目录,现在却有了目录

由于配置文件是json格式,格式要求严格,若格式出现错误则会报错,所以提供一个json格式化校验的网站https://www.bejson.com/

你可能感兴趣的:(技术流Clip,gitbook,node.js,gitee)