vuepress-theme-reco/README.md

82 lines
1.9 KiB
Markdown
Raw Normal View History

2020-01-13 16:41:11 +08:00
<p align="center"><a href="https://vuejs.org" target="_blank" rel="noopener noreferrer"><img width="150" src="https://i.loli.net/2020/01/13/TPKA1wp6s4ufSm2.png" alt="Vue logo"></a></p>
2019-04-15 10:35:40 +08:00
2019-08-21 20:01:00 +08:00
## Introduce
2019-08-21 19:55:02 +08:00
1. 这是一个vuepress主题旨在添加博客所需的分类、标签墙、分页、评论等功能
2019-08-21 20:01:00 +08:00
2. 主题追求极简,根据 vuepress 的默认主题修改而成,官方的主题配置仍然适用;
3. 效果:[午后南杂](https://www.recoluan.com)
2020-04-19 20:34:33 +08:00
4. 文档:[vuepress-theme-reco-doc](https://vuepress-theme-reco.recoluan.com)、[github 源](https://vuepress.github.io)、[zeit 源](https://vuepress-reco-doc.now.sh)
2019-04-15 10:35:40 +08:00
2019-09-06 19:42:34 +08:00
## Quick start
**npx**
```
npx @vuepress-reco/theme-cli init my-blog
```
**npm**
```bash
# init
npm install @vuepress-reco/theme-cli -g
theme-cli init my-blog
# install
cd my-blog
npm install
# run
2019-09-30 13:06:20 +08:00
npm run dev
2019-09-06 19:42:34 +08:00
# build
npm run build
```
**yarn**
```bash
# init
yarn global add @vuepress-reco/theme-cli
theme-cli init my-blog
# install
cd my-blog
yarn install
# run
yarn dev
# build
yarn build
```
2019-08-21 19:55:02 +08:00
## Preview
2019-04-15 10:35:40 +08:00
2020-01-13 16:41:11 +08:00
![size.png](https://i.loli.net/2020/01/13/nCbXp13lRG2TNeD.png)
2020-01-13 16:41:11 +08:00
![style.png](https://i.loli.net/2020/01/13/ke1VirShQRLnEd7.png)
2019-04-15 10:35:40 +08:00
2020-01-13 16:41:11 +08:00
![dark.png](https://i.loli.net/2020/01/13/Lj6XbwdmDFCYH9k.png)
![home.png](https://i.loli.net/2020/01/13/nra3kbYSlxojmw4.png)
2019-04-15 10:35:40 +08:00
2020-01-21 11:23:14 +08:00
## Contributors
2019-08-21 19:55:02 +08:00
2020-01-27 15:17:15 +08:00
**衷心感谢为此项目贡献过宝贵代码的朋友们**
|昵称|贡献记录|
|:-:|-|
|[kangxu](https://github.com/kangxukangxu)|[vuepress-theme-reco@0.x](https://github.com/recoluan/vuepress-theme-reco/commit/ec7426a88d50cf8d9f90a7ad9b731a10da7f438b)|
|[Ekko](https://github.com/danranVm)|[vuepress-theme-reco-demo@1.x](https://github.com/recoluan/vuepress-theme-reco-demo/commit/6d2bbe919e7f6564b8c8173558d197e38e024dc5)|
2019-08-21 19:55:02 +08:00
**衷心感谢美女设计师**
|昵称|贡献内容|
|:-:|-|
|[Zoey]()|主题图标调整定稿|
|冰冰|主题图标初稿|
2019-04-15 10:35:40 +08:00
## License
2019-05-08 17:45:55 +08:00
[MIT](https://github.com/recoluan/vuepress-theme-reco/blob/master/LICENSE)