200315&docsify常用玩法

docsify常用玩法

1. 本地启动

• http-server是一个npm服务端启动插件，可通过npm安装后使用

npm i -g http-server

如果index.html直接在根目录，
运行:http-server
访问:http://192.168.1.106:8080

如果index.html在docs目录，则
运行:http-server docs/
访问:http://192.168.1.106:8080

//启动的是根目录下的index.html
docsify serve

//启动的是docs目录下的index.html
docsify serve docs/

//需要先 docsify init命令执行一下

2. 简介

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行

优点:
这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 .html 文件“污染” commit 记录，只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。

缺点:
相比来说，每次展示都要运行转译，速度上会略慢与 GitBook、Hexo

3. 快速开发的方式

npm i docsify-cli -g
验证是否验证成功: docsify -v

4. docsify 可以用来干什么

• 1.初始化项目docsify init ./
• 2.启动本地服务docsify serve ./

5. 如何设置封面

通过设置coverpage参数，可以开启渲染封面的功能。

• 首先需要在index.html文件中的window.$docsify添加coverpage: true选项：

window.$docsify = {
    coverpage: true
  }

• 接着在项目根目录创建_coverpage.md文件，内容格式如下：

![logo](_media/icon.svg)
# 我的文档网站
## 个人文档网站
> 一个神奇的文档网站生成巩固

* Simple and lightweight (~12kb gzipped)
* Multiple themes
* Not build static html files

[GitHub](https://github.com/docsifyjs/docsify/)
[Get Started](#quick-start)
[Get Started](#quick-start)

6. 侧边栏如何设置

• 首先需要在index.html文件中的window.$docsify添加loadSidebar: true,选项：

window.$docsify = {
    loadSidebar: true
  }

• 接着在项目根目录创建_sidebar.md文件，内容格式如下：

* [home1](home1)
* [home2](home2)
* [bar](bar/)
* [bar/a](bar/a)

7. docsify 如何发布

单分支master，提交到master，部署master发布gitpage

如果网站没有更新，多半是缓存问题，清除缓存即可。

8. sider里面如何设置 分割线？

可以不用分割线，做好层级划分即可。

* 1912(0/13)
	* [191229&docsify常用玩法&本地启动](main/191229&docsify常用玩法&本地启动)
* 2001(0/41)
	* [200102&json-server常用方法&安装启动](main/200102&json-server常用方法&安装启动)

参考

docsify官网