一、根目录结构
| 目录名称 |
目录描述 |
| src |
电子书源码文件,book.json修改"root":"src" |
| book.json |
gitbook项目配置文件 |
| _book |
开发运行文件目录 |
| build |
打包执行生产的html、pdf、epub、mobi文章 |
| .gitignore |
git文件忽略 |
| node_modules |
项目插件依赖包 |
| package.json |
项目配置文件,npm init生成 |
| package-lock.json |
项目依赖锁定配置文件,自动生成 |
二、src目录结构
| 目录名称 |
目录描述 |
| SUMMARY.md |
菜单模块配置 |
| README.md |
电子书简介/前言页文档 |
| GLOSSARY.md |
词汇/注释术语列表 |
| style |
项目样式文件 |
| img |
主页面图片文件 |
| about |
关于模块文件 |
| doc |
文档模块文件 |
三、book.json相关配置
{
//源码目录配置
"root":"src",
//设置电子书语言为简体中文
"language": "zh-hans",
//样式文件配置
"styles": {
"website": "styles/website.css"
}
}
四、package.json运行命令
"scripts": {
"serve": "gitbook serve",
"build": "gitbook build . ./build/dist",
"pdf": "gitbook pdf . ./build/book.pdf",
"epub": "gitbook epub . ./build/book.epub",
"mobi": "gitbook mobi . ./build/book.mobi"
}
| 运行命令 |
命令描述 |
| npm run serve |
项目开发运行 |
| npm run build |
电子书打包运行 |
| npm run pdf |
项目打包成pdf文件 |
| npm run epub |
项目打包成epub |
| npm run mobi |
项目打包成mobi |