docsify

官网

address
快速的,运行编译,简洁,方便,易用的一款写文档工具,docsify。

安装

npm i docsify-cli -g

使用

  1. 创建目录并进入:mkdir documents && cd documents
  2. 初始化项目:docsify init ./docs
  3. 运行项目:docsify serve docs

结构

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

  • index.html 入口文件
  • README.md 会做为主页内容渲染
  • .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件

发布

我这里用的gitee,GitHub总打不开,gitee的静态页面服务开启非常简单。
官方部署
demo




如果你遇到了前端难题,或者需要一对一帮扶服务,请到淘宝搜索店铺:前端在线或扫下面二维码

  转载规则


《docsify》宋宇采用知识共享署名 4.0 国际许可协议进行许可。
  目录