安裝
安裝node拒逮,然后建議全局安裝docsify-cli,有助于在本地初始化和預覽網(wǎng)站炊林。
npm i docsify-cli -g
如果需要部署到gitHub彩倚,則也安裝一下git筹我。
初始化
使用init命令初始化。如果要在./docs子目錄中編寫文檔帆离,則可使用下面命令:
docsify init ./docs
001.png
002.png
上面是執(zhí)行命令過程與自動生成的文件的截圖蔬蕊,下面簡單介紹下docs中的3個文件:
- .nojekyll:讓gitHub不忽略掉以 _ 打頭的文件
- index.html:整個網(wǎng)站的核心文件
- README.md:默認頁面
這里最好只采用docs目錄,官方推薦哥谷,而且將文檔放到gitHub上時岸夯,也必須是docs。
本地預覽文檔
進入docs目錄呼巷,運行本地服務器 docsify serve
囱修,然后在瀏覽器中打開 http://localhost:3000即可。
// 如果要預覽的文檔在docs中王悍,則使用 docsify serve 即可破镰。
docsify serve
005.png
也可以不進入docs目錄運行本地服務器:docsify serve docs
。
gitHub上預覽文檔
應該都知道 gitHub 是放置代碼的網(wǎng)址压储,其實它還有一個強大的預覽文檔的功能鲜漩。如果將 docsify文檔 放置到 gitHub 上,可以通過gitHub直接預覽集惋。
- 在gitHub 建個倉庫孕似。本文檔的倉庫名是 extraordinarywen。
- 在本地獲取倉庫:
git clone https://github.com/taoGod/extraordinarywen.git (倉庫地址)
- 進入本地倉庫刮刑,初始化docsify:
docsify init ./docs
- 提交文檔并防止到gitHub:
git add .
git commit -m 'msg'
git push orgin master // 這個之前需要提供 gitHub 賬號和密碼
- 在此上gitHub看一下該倉庫是否有預想的效果了喉祭。
- 呵呵,顯然還不夠雷绢,不過只差最后一步了泛烙。點擊setting,找到 GitHub Pages翘紊,配置分支為 master barnch /docs folder蔽氨,點擊保存。然后會自動發(fā)布,并且給出發(fā)布的網(wǎng)站地址鹉究。
003.png
004.png
- 點擊上圖中url:Your site is published at url宇立。意不意外,驚不驚喜呢自赔?反正我第一次我是挺驚喜
- 以后你只需要寫東西放到該倉庫妈嘹,網(wǎng)站自動會更新。
更多
再次推薦:docsify匿级。