# GitBookBaseTpl

**Repository Path**: evilrule/GitBookBaseTpl

## Basic Information

- **Project Name**: GitBookBaseTpl
- **Description**: GitBook 基础配置模板，略微配置书籍相关基础信息（book.json）后直接开始写书！
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-11-30
- **Last Updated**: 2020-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GitBookBaseTpl

## 项目介绍
GitBook 基础配置模板，略微配置书籍相关基础信息（book.json）后直接开始写书！

安装教程

1. clone 项目

   ```
   https://gitee.com/evilrule/GitBookBaseTpl.git
   ```

2. 安装 gitbook

   ```
   npm install gitbook-cli -g
   ```

3. 查看 GitBook 版本，以验证安装成功

   ```
   gitbook -V
   ```

4. 安装项目插件和环境

   ```
   gitbook install
   ```

   备注:  从头开始创建一个 gitbook 项目的命令是 

   > gitbook init



## 使用说明

1. 预览书籍，执行命令

   ```
   gitbook serve
   ```

   其他常用命令

   * build 命令可以指定路径

     ```
     gitbook build [书籍路径
     ```

     ][输出路径]

   * serve 命令也可以指定端口 

     ```
     gitbook serve --port 3333
     ```

   * 可以生成 PDF 格式的电子书

     ```
     gitbook pdf ./ ./mybook.pdf
     ```

   * 生成 epub 格式的电子书

     ```
     gitbook epub ./ ./mybook.epub
     ```

   * 生成 mobi 格式的电子书

     ```
     gitbook mobi ./ ./mybook.mobi
     ```

     备注：

     如果生成不了，可能还需要安装一些工具，比如 ebook-convert，或者在 Typora 中安装 Pandoc 进行导出。

2. 构建书籍，执行命令

   ```
   gitbook build
   ```

   构成完成的书籍位于 _book 目录下

## 编辑器推荐

​	[typora.](https://typora.io/)  一款优秀的 Markdown 文本编辑器

​	建议开启图片插入的自动导入相关配置

![](assets/ImgInsertConfig.png)

## res 目录下资源说明

node_modules.rar -- node 模块，由于墙的存在 gitbook 插件的下载非常慢甚至下载不下来，这里提供下载好的 node_modules，直接解压到根目录下的 node_modules 文件夹。

## 其他

Glossary

[中文术语](GLOSSARY.md#中文术语)