# gitbook-init

**Repository Path**: coderup2021/gitbook-init

## Basic Information

- **Project Name**: gitbook-init
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-02-25
- **Last Updated**: 2022-02-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 本仓库用于使用gitbook快速生成html静态生成文档,并通过scp远程复制到服务器


# 快速开始
## 1.初始化目录
```
git clone https://gitee.com/itgou/gitbook-init.git
cd gitbook-init
yarn 
gitbook install
```
## 2.配置远程服务器
编辑publish文件
```shell
#!/bin/bash

gitbook build && 
cd ./_book/ && 
scp ./* root@192.168.2.115:9000:/root/testMenu/ #此处配置远程路径
cd ../ &&
rm -rf ./_book/*
```

## 3.创建md文档
```
在document文件夹下面, 创建note.md
或者自己在根目录下任意目录(除_book外，因为gitbook需要使用该目录名)
```

## 4.编辑SUMMARY.md
```shell
# Summary

- CSS
   * [demo](document/note.md)

```

## 5.发布文档
```
./publish
```

# 注意事项
```
根目录需要有README.md文件
README.md会作为首页渲染，没这个文件会报错
```

# gitbook插件说明
```json
{
	"title": "Jason's Note",
	"author": "Jason",
	"description": "select * from learn",
	"language": "zh-hans",
	"gitbook": "3.2.3",
	"structure": {
		"readme": "README.md"
	},
	"plugins": [
		"-sharing", 
		"expandable-chapters", //目录折叠
		"-lunr", 
		"-search", 
		"search-pro" //搜索
	]
}
```

# npx gitbook install慢的解决方法
安装插件的时候非常慢，不过可以用npm或yarn下载，只需要在plugins里面加入前缀 gitbook-plugin*****
例如上面的plugins可以用一下代码安装
```
yarn add gitbook-plugin-sharing
yarn add gitbook-plugin-expandable-chapters
yarn add gitbook-plugin-lunr
yarn add gitbook-plugin-search
yarn add gitbook-plugin-search-pro
```