前提
- 安裝node->鏈接
安裝
npm i docsify-cli -g
初始化項目
- 如果想在項目的
./docs
目錄里寫文檔岛抄,直接通過init
初始化項目憋槐。
docsify init ./docs
開始寫文檔
初始化成功后溉跃,可以看到 ./docs
目錄下創(chuàng)建的幾個文件
-
index.html
入口文件 -
README.md
會做為主頁內(nèi)容渲染 -
.nojekyll
用于阻止 GitHub Pages 忽略掉下劃線開頭的文件
直接編輯 docs/README.md
就能更新文檔內(nèi)容
本地預(yù)覽
通過運行 docsify serve
啟動一個本地服務(wù)器,可以方便地實時預(yù)覽效果蛛株。默認訪問地址 http://localhost:3000 掌挚。
docsify serve docs