1. 目录

[TOC]

2. GitBook

官方文档

打造完美写作系统：Gitbook+Github Pages+Github Actions

GitBook 简介安装配置

GitHub Pages 搭建教程

2.1. 安装node, npm, nvm, gitbook

ubuntu 参考

# 在/usr/local目录下载nodejs安装包
cd /usr/local
# 不要下最新版本,问题很多 https://nodejs.org/en/download/
get https://nodejs.org/dist/v12.18.1/node-v12.18.1-linux-x64.tar.xz
tar xvf node-v12.18.1-linux-x64.tar.xz
mv node-v12.18.1-linux-x64 nodejs

# 配置，需要创建软链接，以便全局使用：(否则node -v 报错：-bash: /usr/bin/node: 没有那个文件或目录）
ln -s /usr/local/nodejs/bin/node /usr/bin/node
ln -s /usr/local/nodejs/bin/npm /usr/bin/npm

# 解决[/usr/local/bin/npm: 没有那个文件或目录](https://stackoverflow.com/questions/35018661/bash-usr-local-bin-npm-no-such-file-or-directory)
sudo mkdir -p /usr/local/bin
sudo ln -s /usr/bin/npm /usr/local/bin/npm

# 解决npm ERR! code EACCES
sudo chown -R `whoami` ~/.npm
sudo chown -R `whoami` /usr/local/lib/node_modules
sudo chown -R `whoami` /usr/local/bin
# 完成检验：
node -v && npm -v

# 升级 nodejs 和 npm 版本；
sudo npm install n -g
# 不需要最新版的nodejs
# sudo n stable
sudo npm i -g npm
# 配置 npm 镜像源为淘宝源；
npm config set registry http://registry.npm.taobao.org/

# 二、安装 gitbook
# 先安装 gitbook-cli，执行以下命令
sudo npm install -g gitbook-cli
# 查看版本并安装 gitbook
# 输入命令gitbook -V会自动帮我们安装 gitbook，需要注意这一步会很慢，执行 Installing GitBook 3.2.3 大概需要20分钟左右，请耐心等待；
gitbook -V

# 报错 TypeError: cb.apply is not a function
# 62行起的三行都注释掉：fs.stat = statFix(fs.stat), fs.fstat = statFix(fs.fstat), fs.lstat = statFix(fs.lstat)
sudo vim /usr/local/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js

# 验证是否安装成功
# 安装成功后，输入gitbook -V再次查看版本看是否安装成功。仅显示CLI、GitBook version即表示安装成功；
gitbook -V

# 报错[TypeError [ERR_INVALID_ARG_TYPE]]
# node 版本过高，安装node.js的版本管理工具nvm。用nvm再安装一个低版本，可切换。
bash -c "$(curl -fsSL https://gitee.com/RubyKids/nvm-cn/raw/master/install.sh)"
# 重启
nvm install v12.18.1
nvm use v12.18.1
npm install gitbook-cli

# 进入自己的gitbook目录
mkdir ~/Desktop/NoteBook/gitbook
cd ~/Desktop/NoteBook/gitbook
gitbook init

# 安装完毕。编辑SUMMARY.md和其他文件后发布
# 插件可自动生成目录
npm install -g gitbook-summary
cd ~/Desktop/Notebook
book sm

gitbook init
gitbook build

# 启动服务，可用于本地浏览器浏览
gitbook serve &
# 用浏览器查看我们创作的内容
http://localhost:4000/

linux 卸载node重新安装 /usr/local/bin/npm: 没有那个文件或目录 npm ERR! code EACCES TypeError: cb.apply is not a function 各种错误

2.2. 使用

打造完美写作系统：Gitbook+Github Pages+Github Actions

2.2.1. 本地浏览器

启动服务，可用于本地浏览器浏览 gitbook serve 用浏览器查看我们创作的内容 http://localhost:4000/

2.2.2. 插件

编写 book.json

{
    "title": "lzw笔记",
    "outputfile": "SUMMARY.md",
    "catalog": "all",
    "ignores": [],
    "unchanged": [],
    "sortedBy": "-",
    "disableTitleFormatting": true,
    "plugins": [
        "favicon-absolute",
        "katex",
        "-lunr",
        "-search",
        "search-pro",
        "splitter",
        "page-treeview",
        "edit-link",
        "anchor-navigation-ex",
        "expandable-chapters",
        "copy-code-button"
    ],
    "pluginsConfig": {
        "page-treeview": {
            "copyright": "Copyright © aleen42",
            "minHeaderCount": "2",
            "minHeaderDeep": "2"
        },
        "edit-link": {
            "base": "//github.com/xxx/notebook/edit/master",
            "label": "编辑此页面"
        },
        "favicon-absolute": {
            "favicon": "/favicon.ico"
        }
    }
}

使用

1. book.json内添加插件"plugins": ["插件名"],新插件放前面,install完了就中断。 gitbook install
2. 也可以分别直接用淘宝镜像下载npm包，更快

nvm use v18

npm install gitbook-plugin-favicon-absolute -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-katex -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-search-pro -g --registry=https://registry.npm.taobao.org/
npm install gitbook-summary -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-expandable-chapters --save -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-copy-code-button --save -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-anchor-navigation-ex --save -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-splitter -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-page-treeview -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-edit-link -g --registry=https://registry.npm.taobao.org/
npm install mathjax@2.7.6 -g --registry=https://registry.npm.taobao.org/
npm install gitbook-plugin-mathjax-pro -g --registry=https://registry.npm.taobao.org/
npm install staticrypt -g --registry=https://registry.npm.taobao.org/

• 自动生成目录gitbook-summary , 根目录执行 book sm
• 网页目录可折叠"expandable-chapters"
• 复制代码按钮"copy-code-button"
• 标题导航"anchor-navigation-ex"
• 侧边栏宽度可调节 "splitter"
• 页面顶部显示目录 "page-treeview"
• 在线编辑文件 "edit-link"
• LaTex插件 "katex" > "mathjax-pro"
• 导出整本电子书 calibre

# 安装 calibre
sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin
# 可以导出为 pdf、epub 等
gitbook pdf ./ ./mybook.pdf
gitbook epub ./ ./mybook.epub
gitbook mobi ./ ./mybook.mobi

禁用

自带的：在插件名前-；引入的：json中删除

"plugins":[ "-search"]

2.3. 启用GitPage

打造完美写作系统：Gitbook+Github Pages+Github Actions

GitBook 简介安装配置

gitbooks-devops-roadmap

GitHub Pages 搭建教程

• 选网页主题，进github仓库，fork后改名xxx.github.io
• settings——pages——custom domain———填入xxx.github.io或者其他花名

2.4. gitbook上传到gitpage网页

2.4.1. 初次部署

vscode左下新建gitbook发布分支gh-pages。

main分支只有源代码和配置文件； gh-pages分支生成gitbook，删除其他所有不必要的内容，上传到仓库后会被同步到gitpage网站。

• vscode左下切换到发布分支gh-pages。

git checkout gh-pages

• 创建gitbook，生成_book文件夹

cd _book
gitbook init
gitbook build

• 本地提取_book文件夹内文件，删除父目录内其他所有文件。
• 同步。
• settings——pages——branch——gh-pages——save
• 查看 gitbook 是否生效 https://xxx.github.io/NoteBook/
• 切换回 main 分支。

  2.4.2. 日后部署

  使用gh-pages插件将本地静态页面HTML文件推送到远处仓库gh-pages分支

npm install gh-pages -g
gh-pages -d _book

2.5. PicGo 图床管理

项目地址

使用手册

jsDelivrCDN自定义域名加速——https://cdn.jsdelivr.net/gh/xxx/notebook-img

picgo设置——设置快捷键——禁用快速上传快捷键

2.6. 配置自定义域名

1. 选择阿里云域名购买，市场份额过半。top和xyz两个新顶级域名 比较便宜。（top不良使用率高，xyz长期费用贵）
2. 配置 DNS 解析

# dig 命令显示自定义域名指向的IP地址
dig xxx.github.io

# 报错无dig
sudo apt install bind9-dnsutils
# 再报错：未满足的依赖关系：
# bind9-dnsutils : 依赖: bind9-libs (= 1:9.16.1-0ubuntu2) 但是 1:9.16.1-0ubuntu2.10 正要被安装
sudo apt remove bind9-libs
sudo apt install bind9-libs
sudo apt install bind9-dnsutils

dig xxx.github.io
# 将以下应答中的所有 ipv4 地址填入阿里云
;; ANSWER SECTION:
xxx.github.io.    5    IN    A    185.199.111.153
xxx.github.io.    5    IN    A    185.199.110.153
xxx.github.io.    5    IN    A    185.199.109.153
xxx.github.io.    5    IN    A    185.199.108.153


# 在阿里云域名解析设置中添加四条纪录，格式如下：https://dns.console.aliyun.com/#/dns/setting/l2w.top

# 记录类型 A，主机记录 @，解析请求来源 默认，记录值 185.199.108.153 （上面的IP地址）， TTL 1小时

# 再加一条——记录类型 CNAME，主机记录 www，解析请求来源 默认，记录值 xxx.github.io， TTL 1小时

1. 在网站仓库主分支新建文件 CNAME，填写域名 l2w.top。（踩坑：直接在仓库-设置-Pages中填域名不行，每次重建网站都会被清空。）

3. 其他

3.1. windows版本上使用（失败。。。）

1. 下载安装nodejs及附加组件
   • 下载安装v12.x版本的nodejs，其中msi版本可以自动配置npm环境变量，
   • 安装时允许下载python等附加依赖组件，
   • cmd输入node -v查看自己安装是否成功。
2. 安装gitbook
   • cmd输入npm install gitbook-cli -g；
   • 该命令安装后gitbook包会默认放在nodejs安装路径下的node_global文件夹下，所以要想全局使用gitbook命令，还需要将该文件夹设置为环境变量。
   • 设置完环境变量后，可以在控制台使用gitbook -V查看是否安装成功(这里V是大写)。
     • 报错TypeError: cb.apply is not a function，根据报错信息C:\Users\MyPC\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287，可知需要更新依赖项。
     • 进入node模块依赖库——cd C:\Users\MyPC\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\
     • 安装最新版graceful-fs依赖模块——npm install graceful-fs@latest --save
     • 输入gitbook -V查看是否解决。
     • 还是报错Error: read ECONNRESET。
     • npm install -g cnpm --registry=https://registry.npm.taobao.org
   • npm install @gitbook-ng/gitbook

3.2. 请求加入谷歌索引

知乎参考

1. 查看网站是否被Google收录：打开Google搜索输入site:l2w.top，一般没有收录所以查询不到
2. 手动请求收录：进入Google Search Console——点击左上角添加资源——弹窗选择右边的网址前缀——选择最快的HTML文件验证方法——下载随机生成的.html验证文件，上传到网址根目录——自行测试该网址成功后回到console完成验证
3. 添加Sitemaps给爬虫加速（特别是大网站、新网站、内部相互链接少的网站）：进入XML-Sitemaps.com，输入个人网站地址，点击start——搜索完成后view details，下载sitemap.xml文件并上传到网站根目录——回到Console点击左侧菜单站点地图，添加网址
4. 手动请求优先编入索引（可能有效，数小时~一两周）：点击console上方搜索框输入自己的网址——若显示未收录点击“请求编入索引”——大约等待不超过半天就能检索到（实测只检测到了index根站点，子文件夹内容没有检索到）

3.3. 标题最好少于20字

否则手机悬浮目录只能看见大片空白

3.4. 加密文档

工具——技术实现，类似的许多工具

此方法存在重大漏洞！！！（已解决~）

首先加密原理是：待加密的明文md文件通过本地的gitbook生成了明文html文件，然后将其移动到忽略上传的文件夹，再使用工具本地加密并替换原来的明文html。

之后上传GitHub仓库时仅有加密后的暗文html，从而完成加密（没有上传明文md和明文html）。理论上互联网用户无法在gitbook网站和github仓库访问该内容，除非输入加密网址的密码。

但是！最近才发现，可以通过gitbook网站的搜索框直接搜到加密网页的内容！

后续解决方案

原因是gitbook-plugins-search-pro插件在生成html的时候就生成了一个_book/search_plus_index.json文本索引，里面包含所有文档的所有文本信息。把替换这个文件写进脚本就可以屏蔽搜索了。（以后还是隐私信息尽量不上网）。

具体来说就是：先移走要加密的md文件，gitbook build生成一个不含有加密信息的json索引保存起来——然后把要加密的md文件弄回来，再次build，把这次的含有加密明文的json用之前的文件替换掉——然后再进行加密等操作。

ShellScript脚本代码如下（注意把staticrypt的加密密码mima换成自己的）

#!/bin/zsh
cd ~/Desktop/notebook && book sm && cp SUMMARY.md README.md && mv 9me/test.md node_modules/test.md && gitbook build &&  mv _book/search_plus_index.json node_modules/search_plus_index.json && mv node_modules/test.md 9me/test.md && gitbook build && staticrypt _book/9me/test.html mima --short && rm _book/9me/test.html && mv _book/9me/test_encrypted.html _book/9me/test.html && mv 9me/test.md node_modules/test.md && mv node_modules/search_plus_index.json _book/search_plus_index.json  && gh-pages -d _book && git add --all && git commit -a -m "." --no-verify && git push && mv node_modules/test.md 9me/test.md && echo ====================success==================

3.5. Nginx 网站加密认证

https://segmentfault.com/a/1190000018195589