vuepress-theme-reco/README.md

80 lines
2.3 KiB
Markdown
Raw Permalink 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
2020-07-13 19:45:35 +08:00
1. This is a Vuepress theme, which is designed to add blog categories, tag walls, pagination, comments and other functions required;
2. The theme is minimalist, modified according to the default theme of Vuepress, and the official theme configuration is still applicable;
3. Demo[午后南杂](https://www.recoluan.com)
4. Docs[vuepress-theme-reco-doc](https://vuepress-theme-reco.recoluan.com)、[github source](https://vuepress.github.io)、[zeit source](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**
```
2020-07-13 19:45:35 +08:00
npx @vuepress-reco/theme-cli init
2019-09-06 19:42:34 +08:00
```
**npm**
```bash
npm install @vuepress-reco/theme-cli -g
2020-07-17 11:17:13 +08:00
2020-07-13 19:45:35 +08:00
theme-cli init
2019-09-06 19:42:34 +08:00
```
**yarn**
```bash
yarn global add @vuepress-reco/theme-cli
2020-07-17 11:17:13 +08:00
2020-07-13 19:45:35 +08:00
theme-cli init
2019-09-06 19:42:34 +08:00
```
2020-07-13 19:45:35 +08:00
## Multi-language
2019-04-15 10:35:40 +08:00
2020-07-13 19:45:35 +08:00
|language|language code|
|:-:|-|
|Simplified Chinese|`zh-CN`、`zh-SG`|
|Traditional Chinese|`zh-HK`、`zh-MO`、`zh-TW`|
|Japanese|`ja-JP`|
|Korean|`ko-KR`|
|English|`en-US` and other|
2019-04-15 10:35:40 +08:00
2020-07-13 19:45:35 +08:00
## Update record
2020-01-13 16:41:11 +08:00
2020-07-13 19:45:35 +08:00
[Record](https://github.com/vuepress-reco/vuepress-theme-reco/blob/develop/CHANGELOG.md)
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-07-13 19:45:35 +08:00
<a style="display: block;margin-top: 10px" href="https://github.com/vuepress-reco/vuepress-theme-reco/graphs/contributors" target="_black">
<img
alt="vuepress-theme-reco"
src="https://img.shields.io/github/contributors/vuepress-reco/vuepress-theme-reco?style=for-the-badge&logo=github&label=vuepress-theme-reco" />
</a>
2020-01-27 15:17:15 +08:00
2020-07-13 19:45:35 +08:00
<br />
2019-08-21 19:55:02 +08:00
2020-07-13 19:45:35 +08:00
<a style="display: block;margin-top: 10px" href="https://github.com/vuepress-reco/vuepress-reco.github.io/graphs/contributors" target="_black">
<img
alt="vuepress-reco.github.io"
src="https://img.shields.io/github/contributors/vuepress-reco/vuepress-reco.github.io?style=for-the-badge&logo=github&label=vuepress-reco.github.io" />
</a>
2019-08-21 19:55:02 +08:00
2020-07-13 19:45:35 +08:00
<br />
**P.S. Thanks to the two beauties for their contributions to the theme logo: Zoey and 冰冰.**
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)
2020-07-13 19:45:35 +08:00
## Preview
![size.png](https://i.loli.net/2020/01/13/nCbXp13lRG2TNeD.png)
![style.png](https://i.loli.net/2020/01/13/ke1VirShQRLnEd7.png)
![dark.png](https://i.loli.net/2020/01/13/Lj6XbwdmDFCYH9k.png)
![home.png](https://i.loli.net/2020/01/13/nra3kbYSlxojmw4.png)