安装
安装地址
node.js https://nodejs.org/en/download/
typora https://typora.io/
git https://git-scm.com/downloads
安装好node.js后会默认安装npm(node 包管理工具)
npm install -g gitbook-cli
输入 gitbook -V 查看是否安装成功
gitbook使用
创建一个文件夹,在文件夹内运行
gitbook init
此处可用用shift+鼠标右键选择 用pwoershell命令打开窗口。
会自动生成目录结构,
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 2020/4/26 10:31 16 README.md
-a---- 2020/4/26 10:38 40 SUMMARY.md
其中README.md 相当于简介,SUMMARY.md 相当于大纲,用typora分别打开两个文件进行修改。
* [简介](README.md)
* [第一章](chapter1/README.md)
- [第一节](chapter1/section1.md)
- [第二节](chapter1/section2.md)
* [第二章](chapter2/README.md)
- [第一节](chapter2/section1.md)
- [第二节](chapter2/section2.md)
* [结束](end/README.md)
将SUMMARY.md写成上述内容,然后在文件夹内运行gitbook init,就会自动生成chapter1文件夹以及相关文件,不用再手动去创建。
生成预览
gitbook serve
Error: ENOENT: no such file or directory, stat ‘C:\Users\Administrator\Documents\Gitbook\gongwuyuan_book\gitbook\gitbook-plugin-livereload\plugin.js’
如果出现以上报错,找到如下文件 C:\Users\Administrator.gitbook\versions\3.2.3\lib\output\website\copyPluginAssets.js 将所有confirm: true 语句改为 confirm: false
之后打开 http://localhost:4000 预览。
生成静态网站
执行 gitbook build 命令,默认将生成的静态网站输出到 _book 目录。
常用命令
gitbook init //初始化目录文件
gitbook help //列出gitbook所有的命令
gitbook --help //输出gitbook-cli的帮助信息
gitbook build //生成静态网页
gitbook serve //生成静态网页并运行服务器
gitbook build --gitbook=2.0.1 //生成时指定gitbook的版本, 本地没有会先下载
gitbook ls //列出本地所有的gitbook版本
gitbook ls-remote //列出远程可用的gitbook版本
gitbook fetch 标签/版本号 //安装对应的gitbook版本
gitbook update //更新到gitbook的最新版本
gitbook uninstall 2.0.1 //卸载对应的gitbook版本
gitbook build --log=debug //指定log的级别
gitbook builid --debug //输出错误信息
typora 使用
使用typora的感受后,有两大优点,第一个是支持实时渲染,现在很多markdown编辑器支持左右两边预览,但是这样子很占屏幕,第二就是typora对插入图片的支持性很高,支持网络图片的直接粘贴,同时也支持复制图片到.md的文件夹,这样就不怕图片丢失。
git 使用
常用命令
git init
git clone
git config --list
git config -e --global
git config --global user.name "name"
git config --global user.email "email"
git add
git rm
git commit -m [message]
git branch -a
git checkout branch-name
git checkout -b branch-name
git cherry-pick branch-name
git status
git log
git diff
git push [remote] [branch]
git reset --hard
git reset --hard [commit]
git commit --amend
git config --global core.editor vim
忽略一些文件
vim .gitignore
示例
#过滤数据库文件、sln解决方案文件、配置文件
*.mdb
*.ldb
*.sln
*.config
#过滤文件夹Debug,Release,obj
Debug/
Release/
obj/
比如运行完gitbook build后会出现_book的文件夹,但是不想提交到github或码云上,则可以在.gitignore里加入_book,则git status就不会追踪这个文件夹。
windowns下使用git可能出现的问题。
1,git add 中文名,会出现转义的情况
git config --global core.quotepath false
2,
warning: LF will be replaced by CRLF in XXXX/README.md.
原因是存在符号转义问题,windows中的换行符为 CRLF, 而在linux下的换行符为LF,所以在执行add . 时出现提示,解决办法:
git config --global core.autocrlf false
==注意:==建议上面的办法不要使用,忽略警告即可。
在nginx下是使用
安装好nginx后,修改nginx/nginx.conf的配置文件。
server {
listen 8080; #nginx监听的端口
server_name localhost; #拦截的用户访问路径
#charset koi8-r;
#access_log logs/host.access.log main;
# 访问本地绝对路径下的静态html
location / {
#root html;
root /home/admin123/civil_servant/_book;#gitbook build 生成的文件
index index.html index.htm;
}
重启后nginx服务,打开http://localhost:8080即可查看gitbook文件,如果想局域网内的都可以查看,要把localhost替换为相应的ip地址。