详细文档
1.1 gitbook介绍
GitBook 使用的markdown语法 在此基础上做了一些 写作便利性的加强
Markdown 是一种轻量级的「标记语言」,优点在于:
- 专注你的文字内容而不是排版样式
- 轻松的导出HTML、PDF和本身的.md文件
- 纯文本内容,兼容所有的文本编辑器与字处理软件
- 可读、直观。适合所有人的写作语言
1.2 安装gitbook
npm install gitbook-cli -g # 安装gitbook
gitbook help # 查看gitbook帮助信息
gitbook -V # 查看gitbook版本信息
1.3 创建一个gitbook项目
C:\Users\tom> cd C:\aa\test-book # 进入要进行书写的空文件夹
C:\aa\test-book> gitbook init # 初始化文件夹
C:\aa\test-book> gitbook serve --port 80 # 在本地80端口运行gitbook这个服务
# 注访问:http://localhost:80
1.4 设置gitbook 样式
- book.json
{
"language": "zh-hans",
"plugins": [
"livereload",
"highlight",
"search",
"lunr",
"-sharing",
"fontsettings",
"theme-default"
],
"styles": {
"website": "styles/website.css"
}
}
- styles/website.css
.gitbook-link {
display: none!important;
}
2.1 设置目录层级结构
这里推荐直接在_book同级目录下创建book.json文件,然后将3.3生成目录文件的配置粘贴进去即可
- 说明
1. test-book 目录下的 SUMMARY.md 文件是 gitbook init 自动生成的 你也可以自己创建 这个markdown文件决定了你文档的目录结构
2. SUMMARY.md 就是一个markdown文件 当中内容遵循如下格式,星号 空格 方括号 圆括号【 * [前言](README.md) 】