推薦一個vuepress模板，一鍵快速搭建文檔站

• 2021 年 2 月 16 日
• 筆記
• js, VUE, vuepress, vuepress主題, vuepress插件, vuepress模板, 前端

介紹

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

為什麼推薦這個模板？

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

而且對應的插件能直接看到效果，使用起來更能得心應手。

在線案例

在線文檔

主要內容（持續更新中）

項目中特別展示了一些小眾模板、主題、插件，推薦大家關注和使用

1. 主題

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

2. 插件

插件列表列舉了網站上已經安裝有效的VuePress插件，包括官方插件、社區插件和小眾插件。

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

怎麼用？

第一步

下載 Vuepress Template 的倉庫程式碼

git clone //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列表的補充。