vuepress-template是一个简单的VuePress案例模板,目的是让用户能够直接clone这个仓库,做为初始化一个VuePress网站启动项目,而后在这个项目的基础上新增自定义配置和功能。vue
有部分刚接触VuePress的同窗,按照官方教程操做下来会遇到大大小小的问题,特别是文件目录、打包、插件安装这几块内容。若是直接复制官方的仓库又会比较大,因此若是有一个这样的简洁的初始模板,直接启动使用就很方便了。git
并且对应的插件能直接看到效果,使用起来更能驾轻就熟。github
在线文档web
项目中特别展现了一些小众模板、主题、插件,推荐你们关注和使用npm
社区已经开发了大量主题,这里列举一些不常见的,可是风格比较独特的主题。好比:vuepress-theme-blogplus 一款简洁的博客主题app
插件列表列举了网站上已经安装有效的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列表的补充。