介绍
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列表的补充。