reference: https://yuzeshan.gitbooks.io/gitbook-studying/content/index.html
安装node.js
直接到官网下载exe安装即可,参考网站
使用npm安装gitbook
注意:不知道什么原因,gitbook命令只能在nodejs的终端中使用,在系统的cmd或者powershell中不被识别
npm install gitbook-cli -g
在node.js command prompt 中使用 gitbook -V 确认安装成功
gitbook使用
打开node.js command prompt
运行gitbook
常用命令
本地预览: gitbook serve ./book_name
输出静态网站: gitbook build ./book_path ./output_path
查看帮助: gitbook help
构建github blog
注意: 仓库名称必须为usename.github.io,注意大小写,跟官方教程有点不一样,这个后期再弄。参考
- 创建github远程仓库
- 克隆仓库到本地: git clone ….
- 创建一个新的分支 git checkout -b gh-pages(分支名必须为gh-pages)
- 将分支push到仓库
- 切换到主分支master
- 将gitbook build得到的静态网页文件复制到改仓库的本地目录下
- 提交到远程仓库
- 打开http://username.github.io可以看到网页版本的gitbook
gitbook 插件
支持中文搜索的search-pro
github: https://github.com/gitbook-plugins/gitbook-plugin-search-pro
在终端运行命令:
1 | npm install gitbook-plugin-search-pro |
修改book.json:
1 | { |
gitbook editor
如何切换预览模式?
新版的gitbook editor将预览模式的切换收入了右下角的“?”那里,选择“Edit Markdown”即可切换。
参考链接: https://www.zhihu.com/question/56703698/answer/150102664