1. 使用 gitbook 搭建学习笔记网站
该文章仅支持 linux 环境搭建
1.1. 安装 node
安装 node 版本不能太高,推荐 10.24.1 版本,通过下列命令安装 node。
# installs nvm (Node Version Manager)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
# download and install Node.js (you may need to restart the terminal)
nvm install 10
# verifies the right Node.js version is in the environment
node -v # should print `v10.24.1`
# verifies the right npm version is in the environment
npm -v # should print `6.14.12`
参考链接:https://nodejs.org/en/download/package-manager
1.2. 使用 gitbook 建站
1.2.1. 命令行安装 gitbook
1.安装 gitbook-cli,命令如下:
npm install gitbook-cli -g
2.安装 gitbook,执行下列命令:
gitbook -V
安装速度比较慢,等待几分钟。
如果 npm 安装比较慢或者下载插件很慢,可以尝试切换镜像源。
切换镜像源命令
npm config set registry https://registry.npm.taobao.org
查看当前镜像源命令
npm config get registry
官方原始 NPM 镜像网址是:https://registry.npmjs.org/
淘宝 NPM 镜像:https://registry.npm.taobao.org
阿里云 NPM 镜像:https://npm.aliyun.com
腾讯云 NPM 镜像:https://mirrors.cloud.tencent.com/npm/
华为云 NPM 镜像:https://mirrors.huaweicloud.com/repository/npm/
网易 NPM 镜像:https://mirrors.163.com/npm/
中国科学技术大学开源镜像站:http://mirrors.ustc.edu.cn/
清华大学开源镜像站:https://mirrors.tuna.tsinghua.edu.cn/
1.2.2. gitbook 初始化
空项目需要初始化,命令如下:
gitbook init
初始化后项目中会生成 README.md(说明文件) 和 SUMMARY.md(所有文章的列表目录)
1.2.3. 安装 gitbook 插件
项目中有book.json,该文件配置 gitbook 的属性插件等,其中plugins中为需要的插件,第一次需要执行如下命令下载插件库:
gitbook install
部分插件手动安装命令:
npm install gitbook-plugin-mathjax-pro
npm install mathjax@2.7.6
npm install gitbook-plugin-anchor-navigation-ex
如果下载缓慢或者部分插件下载安装失败,可以删除项目中的node_modules,直接解压node_modules.zip(附带一份插件数据,解决插件版本不对或者下载失败问题)
1.2.4. 编译生成 gitbook 网站的资源
执行如下命令,根据 md 文件生成网站页面代码在_book文件夹中:
gitbook build
1.2.5. 启动 gitbook 服务(看情况选择执行)
如下命令启动本地服务(本地测试看效果可以使用):
gitbook server