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

介紹

vuepress-template是一個簡單的VuePress案例模板,目的是讓用戶能夠直接clone這個倉庫,做爲初始化一個VuePress網站啓動項目,而後在這個項目的基礎上新增自定義配置和功能。vue

爲何推薦這個模板?

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

並且對應的插件能直接看到效果,使用起來更能駕輕就熟。github

在線案例

在線文檔web

主要內容(持續更新中)

項目中特別展現了一些小衆模板、主題、插件,推薦你們關注和使用npm

1. 主題

社區已經開發了大量主題,這裏列舉一些不常見的,可是風格比較獨特的主題。好比:vuepress-theme-blogplus 一款簡潔的博客主題app

2. 插件

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

特別是小衆插件,由於有些插件提供的功能可能需求量比較小,有些定製化的成分,vuepress社區插件列表並不必定收錄,可是仍是可能會有一小部分同窗須要這些插件,那麼咱們這個網站就可能會把這些插件收錄進來,供有須要的同窗查閱。好比vuepress-plugin-qrocde,一個展現當前網址二維碼供移動設備掃描的插件(如今已經被官方的 awesome-vuepres 列表收錄了)學習

怎麼用?

第一步

下載 Vuepress Template 的倉庫代碼網站

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

第二步

安裝依賴ui

cd vuepress-template
yarn # 或者npm i

第三步

啓動項目,隨後便可根據本身的需求修改配置、編寫文檔內容

npm run docs:dev

第四步

打包項目

npm run docs:build

結果會在docs/.vuepress/目錄下生成一個dist文件夾,裏面就是打包後的代碼

倡議

這些自定義開發的插件和主題,也是一個新的學習渠道。若是你有本身開發的插件或者主題,也歡迎提交項目網址到 VuePress Template 的 issues或者直接提交PR,維護者會考慮收錄到插件列表裏,做爲官方awesome-vuepress列表的補充。

相關文章
相關標籤/搜索