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


介紹

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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM