docsify简单教程

简介

一个神奇的文档网站生成器。
简单而轻便（〜18kB压缩）
没有静态构建的HTML文件
多个主题

快速开始

建议docsify-cli全局安装，这有助于本地初始化和预览网站。

npm i docsify-cli -g

初始化

如果在根目录中编写文档

docsify init ./

写作内容

在之后init完成后，你可以看到在文件列表./根目录。

• index.html 作为入口文件
• README.md 作为主页
• .nojekyll 防止GitHub页面忽略以下划线开头的文件

您可以轻松更新文档./README.md，当然您可以添加更多页面。

侧边栏

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

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

创建_sidebar.md：

- [Home](/)
- [Guide](guide.md)

其他详细配置情参考官方文档

配置index.html

下面是我参考官方文档修改的一个配置:

  
  
  
  
  
  


  
Please wait...
  
  
  
  
  
  
  

运行

docsify serve --port 4000

访问 http:/localhost:4000 即可查看页面效果

总结

docsify用法和gitbook差不多，但是样式比较好看，个人比较喜欢。

转载于:https://www.cnblogs.com/CatFish/p/8251044.html