vuepress-theme-reco/README.md
2020-07-13 19:45:35 +08:00

80 lines
2.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<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>
## Introduce
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)
## Quick start
**npx**
```
npx @vuepress-reco/theme-cli init
```
**npm**
```bash
# 初始化
npm install @vuepress-reco/theme-cli -g
theme-cli init
```
**yarn**
```bash
# 初始化
yarn global add @vuepress-reco/theme-cli
theme-cli init
```
## Multi-language
|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|
## Update record
[Record](https://github.com/vuepress-reco/vuepress-theme-reco/blob/develop/CHANGELOG.md)
## Contributors
<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>
<br />
<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>
<br />
**P.S. Thanks to the two beauties for their contributions to the theme logo: Zoey and 冰冰.**
## License
[MIT](https://github.com/recoluan/vuepress-theme-reco/blob/master/LICENSE)
## 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)