blog系统-安装docisfy

238 阅读1分钟

前提

安装

npm i docsify-cli -g

初始化项目

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

开始写文档

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

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

直接编辑 docs/README.md 就能更新文档内容

本地预览

通过运行 docsify serve 启动一个本地服务器,可以方便地实时预览效果。默认访问地址 http://localhost:3000

docsify serve docs

参考

可以查看官方文档:docsify.js.org/#/zh-cn/qui…

已收录Dc-Notes