docsify-寫一個自己的網站

https://www.jianshu.com/p/88e70f32b049

docsify

安裝

安裝node，然後建議全局安裝docsify-cli，有助於在本地初始化和預覽網站。

npm i docsify-cli -g

如果需要部署到gitHub，則也安裝一下git。

初始化

使用init命令初始化。如果要在./docs子目錄中編寫文檔，則可使用下面命令：

docsify init ./docs

001.png

002.png

上面是執行命令過程與自動生成的文件的截圖，下面簡單介紹下docs中的3個文件：

• .nojekyll：讓gitHub不忽略掉以 _ 打頭的文件
• index.html：整個網站的核心文件
• README.md：默認頁面

這裏最好只採用docs目錄，官方推薦，而且將文檔放到gitHub上時，也必須是docs。

本地預覽文檔

進入docs目錄，運行本地服務器 docsify serve，然後在瀏覽器中打開 http://localhost:3000即可。

// 如果要預覽的文檔在docs中，則使用 docsify serve 即可。
docsify serve

005.png

也可以不進入docs目錄運行本地服務器：docsify serve docs。

gitHub上預覽文檔

應該都知道 gitHub 是放置代碼的網址，其實它還有一個強大的預覽文檔的功能。如果將 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，點擊保存。然後會自動發佈，並且給出發佈的網站地址。

003.png

004.png

• 點擊上圖中url：Your site is published at url。意不意外，驚不驚喜呢？反正我第一次我是挺驚喜
• 以後你只需要寫東西放到該倉庫，網站自動會更新。

更多

再次推薦：docsify。