推薦一個vuepress模板,一鍵快速搭建文件站

獨書先生發表於2021-02-16

介紹

vuepress-template是一個簡單的VuePress案例模板,目的是讓使用者可以直接clone這個倉庫,作為初始化一個VuePress網站啟動專案,然後在這個專案的基礎上新增自定義配置和功能。

為什麼推薦這個模板?

有部分剛接觸VuePress的同學,按照官方教程操作下來會遇到大大小小的問題,特別是檔案目錄、打包、外掛安裝這幾塊內容。如果直接複製官方的倉庫又會比較大,所以如果有一個這樣的簡潔的初始模板,直接啟動使用就很方便了。

而且對應的外掛能直接看到效果,使用起來更能得心應手。

線上案例

線上文件

主要內容(持續更新中)

專案中特別展示了一些小眾模板、主題、外掛,推薦大家關注和使用

1. 主題

社群已經開發了大量主題,這裡列舉一些不常見的,但是風格比較獨特的主題。比如:vuepress-theme-blogplus 一款簡潔的部落格主題

2. 外掛

外掛列表列舉了網站上已經安裝有效的VuePress外掛,包括官方外掛、社群外掛和小眾外掛。

特別是小眾外掛,因為有些外掛提供的功能可能需求量比較小,有些定製化的成分,vuepress社群外掛列表並不一定收錄,但是還是可能會有一小部分同學需要這些外掛,那麼我們這個網站就可能會把這些外掛收錄進來,供有需要的同學查閱。比如vuepress-plugin-qrocde,一個展示當前網址二維碼供移動裝置掃描的外掛(現在已經被官方的 awesome-vuepres 列表收錄了)

怎麼用?

第一步

下載 Vuepress Template 的倉庫程式碼

git clone https://github.com/openHacking/vuepress-template.git

第二步

安裝依賴

cd vuepress-template
yarn # 或者npm i

第三步

啟動專案,隨後即可根據自己的需求修改配置、編寫文件內容

npm run docs:dev

第四步

打包專案

npm run docs:build

結果會在docs/.vuepress/目錄下生成一個dist資料夾,裡面就是打包後的程式碼

倡議

這些自定義開發的外掛和主題,也是一個新的學習渠道。如果你有自己開發的外掛或者主題,也歡迎提交專案網址到 VuePress Template 的 issues或者直接提交PR,維護者會考慮收錄到外掛列表裡,作為官方awesome-vuepress列表的補充。

相關文章