學習筆記

【Notes】Docsify 快速文件生成

docsifypage

之前一直覺得GitBook有點麻煩,所以一直沒有用,但隨著公司的系統越來越龐大,想要寫的文件越來越多,就好像想寫的文章很多但始終什麼都沒有寫出來XD,今天剛好發現了這個很簡單的文件工具,來和大家分享一下,本來是想要裝好就好了,但我剛剛一併把測試弄到github pages上了。

Docsify介紹

根據Docsify的介紹,基本上它就是把你Markdown的格式轉成靜態網站顯示出來,很簡單也很輕便,然後也有一些外掛可以使用,像我就是抓了一個暗黑模式的切換跟搜尋來用。

Docsify安裝

在開始安裝之前,無論你在Windows、Linux或是Mac的環境底下,你都需要先安裝Node.js,那大家可以到Node.js的官網上去下載最新版的來裝就可以了。

這邊Linux的用戶要注意,如果用epel的repo裝nodejs版本會太舊,到時候Docsify會有可能有無法啟動的問題,我就遇到了XD,升級一番寒徹骨

如果npm裝完,就可以在你要的目錄底下開始建立,基本上輸入下面的指令就可以裝完並啟動了

npm i docsify-cli -g #安裝docsify
docsify init ./docs #初始化
docsify serve docs #本地啟動

啟動後,如果你的3000 Port還在,你在瀏覽器上輸入http://localhost:3000,就可以看到初始的頁面了。

結論

時間有點晚,先進入結論了,Docsify也可以丟到github pages上,這樣就不用再另外找空間,我今天有把測試頁面丟上我的github pages,大家試著裝裝看,用來寫文件真的很不錯好看,我今天還有試著裝了不同的theme,有增加了Dark Mode的切換,還有搜尋框的使用,另外還有一些navbar、跟sidebar的使用,基本上文件的結構搞清楚,用起來算是滿簡單易懂的。

參考資料

[1] 學習撰寫文件,初識好幫手 docsify

[2] 學習使用 Docsify 寫文件