# gitbook-scaffold

**Repository Path**: betgar/gitbook-scaffold

## Basic Information

- **Project Name**: gitbook-scaffold
- **Description**: gitbook脚手架
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gitbook使用
  主要记录一下gitbook的使用，gitbook是一个基于markdown格式的静态文档生成器，这里向小伙伴们展示下如何使用它来生成很nice的文档。


## gitbook的文档
> 因为gitbook官方推广新服务，所以以前的gitbook工具的文档导致无法访问，所以尽量都去gitbook仓库查看。

- [gitbook-official中文文档](https://snowdreams1006.github.io/gitbook-official/zh/setup.html)
- [gitbook中文版文档](https://chrisniael.gitbooks.io/gitbook-documentation/)

- [gitbook的仓库](https://github.com/GitbookIO/gitbook/tree/master/docs)

- [book.json配置](https://github.com/GitbookIO/gitbook/blob/master/docs/config.md)

- [文章结构说明](https://github.com/GitbookIO/gitbook/blob/master/docs/structure.md)

- [多语言](https://github.com/GitbookIO/gitbook/blob/master/docs/languages.md)

- [样例](https://github.com/GitbookIO/gitbook/blob/master/docs/examples.md)

## gitbook的编辑器(editor)

编辑器官方地址 [https://github.com/GitbookIO/editor-legacy](https://github.com/GitbookIO/editor-legacy)



## book.js配置

`book.js`是整个gitbook工程的配置,可以配置文档的**根目录**,使用到的**插件**之类.

root: 文档的根目录



_book: 是gitbook build之后的静态网页