# docsify
> 无需构建快速生成文档页
## 特性
- 无需构建，写完 markdown 直接发布
- 支持自定义主题
- 容易使用并且轻量
## 快速上手
### 创建项目
新建一个空项目，接着创建一个 `docs` 目录并进入到 docs 目录下
```shell
mkdir my-project && cd my-project
mkdir docs && cd docs
```
### 创建入口文件
创建一个 `404.html` 文件，内容为
```html
```
新建 `README.md` 文件，作为主页面
```
# Title
## balabala
```
### 部署！
将项目 `push` 到 GitHub 仓库后到设置页面开启 **GitHub Pages** 功能，选择 `docs/` 选项
## 命令行工具
方便快速创建文档目录，会读取项目的 `package.json` 里的选项作为 docsify 的配置，支持本地预览。
### 安装
```shell
npm i docsify-cli -g
```
### 初始化文档
默认初始化在当前目录，推荐将文档放在 `docs` 目录下
```shell
docsify init docs
```
### 启动本地服务
启动一个 server 方便预览，打开 http://localhost:3000
```shell
docsify serve docs
```
更多选项参考 [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
## 主题
目前提供 vue.css 和 buble.css，直接修改 `404.html` 里的 cdn 地址即可
```html
```
压缩版
```html
```
## 更多功能
### 多页面
`README.md` 作为主页面，如果需要其他页面，直接在文档目录下创建对应的 `*.md` 文件，例如创建一个 `guide.md` 那么对应的路由就是 `/guide`。
### 导航
导航需要自己写在 `404.html` 文件里，效果参考本文档
```html
```
### 配置参数
#### repo
参考本文档的右上角的 GitHub 图标，如果要开启的话，将 `404.html` 里的 script 改成
```html
```
#### max-level
目录最大展开层级，默认值为 6
```html
```
#### el
替换节点元素，默认为 `#app`
```html
```
#### sidebar
设置后 TOC 功能将不可用，适合导航较多的文档，`data-sidebar` 传入全局变量名。
```html
```