天下熙熙,皆为利来
天下攘攘,皆为利去

用Docsify搭建一个在线文档

【说明】一个神奇的文档站点生成器。简单轻巧(~19kB gzipped)!!没有静态构建的html文件!!多个主题!!很好用的一个站点文档。
docsify即时生成您的文档网站。与GitBook不同,它不会生成静态html文件。相反,它可以巧妙地加载和解析您的Markdown文件并将其显示为网站。您需要做的就是创建一个index.html以在GitHub页面上启动和部署它。

快速开始

安装推荐docsify-cli工具,可以方便创建及本地预览文档网站。

npm i docsify-cli -g

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

docsify init ./docs

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

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

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

本地预览网站

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

docsify serve docs

手动初始化

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

index.html




  
  
  
  


  
  
    window.$docsify = {
      //...
    }
  
  


如果系统里安装Python的话,也可以很轻易的启动一个静态服务器。

cd docs && python -m SimpleHTTPServer 3000
赞(0) 打赏一下
未经允许不得转载:iX-清风九里 » 用Docsify搭建一个在线文档
分享到: 更多 (0)

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏