docsify 学习笔记2019-03-28

一、docsify介绍

1.1docsify介绍

（1）docsify是一个文档生成工具，它直接加载 Markdown 文件并动态渲染，同时还可以生成封面页。
（2）不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。
（3）docsify是由现饿了么前端团队@elemeFE的cinwell.li编写的一套文档站点生成框架，github上已有3k+ star，这款框架和其他框架如gitbook等相比，最大的区别就在于docsify不是静态生成html，而通过动态请求markdown编译生成html。

1.2docsify特点

• 无需构建无需编译，写完markdown文档直接发布
• 容易使用并且轻量 (~18kB gzipped)
• 智能的全文搜索
• 提供多套主题
• 丰富的 API
• 支持 Emoji
• 兼容 IE10+
• 支持 SSR (example)
• 快速上手

1.3文档规范的好处

清晰、好看、方便维护

1.4官方网址

对于具体的学习资料，大家可以参考官方网站。

https://docsify.js.org/#/zh-cn/quickstart

1.5其它主流

目前市面上有大致这么几款主流的文档生成站点，分别为docsify、gitbook、Phenomic等，可帮助用户快速搭建文档站点。

二、使用教程

2.1root安装

推荐安装 docsify-cli 工具，可以方便创建及本地预览文档网站。在安装docsify-cli之前需要确保您首先安装node。

npm i docsify-cli -g

2.2普通用户下初始化项目

如果想在项目的 ./docs 目录里写文档，直接通过 init 初始化项目。

docsify init ./docs

2.3开始写文档

初始化成功后，可以看到 ./docs 目录下创建的几个文件

• index.html 入口文件

• README.md 会做为主页内容渲染

• .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

直接编辑 docs/README.md 就能更新网站内容，当然也可以写多个页面。

2.4本地预览网站

运行一个本地服务器通过 docsify serve 命令可以方便的预览效果，而且提供 LiveReload 功能，可以让实时的预览。默认访问 http://localhost:3000 。

docsify serve docs

如果需要启动其他端口，可以直接在后面增加-p 4000表示启动端口为4000

更多命令行工具用法，参考docsify-cli文档。

2.5手动初始化

如果不喜欢 npm 或者觉得安装工具太麻烦，我们其实只需要直接创建一个 index.html 文件。

index.html文件内容具体如下：

2.6侧边栏

为了有侧边栏，那么你可以创建你自己的_sidebar.md：

首先，你需要设置loadSidebar为true。详细信息可在配置段落中找到。

2.6.1 index.html配置如下所示：

2.6.2侧边栏md配置

创建_sidebar.md：

• Home

• Guide

三、demo示例

index.html详细配置示例如下所示：