vitepress-theme-async
Version:
<h1 align="center">vitepress-theme-async</h1>
108 lines (79 loc) • 3.96 kB
Markdown
<h1 align="center">vitepress-theme-async</h1>
<div align="center">
[Gitee](https://gitee.com/ml13/vitepress-theme-async) |
[演示](https://vitepress-theme-async.imalun.com/demosite/) |
[示例预览](https://www.imalun.com) |
[使用文档](https://vitepress-theme-async.imalun.com/)
一个简单而轻量级的 Vitepress 主题。
</div>
<p align="center">
<a title="Github release" target="_blank" href="https://github.com/MaLuns/vitepress-theme-async/releases">
<img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/Maluns/vitepress-theme-async?logo=github">
</a>
<a title="Npm Version" target="_blank" href="https://www.npmjs.com/package/vitepress-theme-async">
<img src="https://img.shields.io/npm/v/vitepress-theme-async?logo=npm&color=%09%23bf00ff" alt="https://img.shields.io/npm/v/vitepress-theme-async?color=%09%23bf00ff">
</a>
<img src="https://img.shields.io/badge/v18.x-x?logo=node.js&label=node" alt="node version">
<img src="https://img.shields.io/github/languages/code-size/MaLuns/vitepress-theme-async?logo=Visual Studio Code&logoColor=blue" alt="GitHub code size in bytes">
<a title="GitHub Discussions" target="_blank" href="https://github.com/MaLuns/vitepress-theme-async/discussions">
<img src="https://img.shields.io/github/discussions/MaLuns/vitepress-theme-async?color=9cf&logo=github" alt="GitHub Discussions">
</a>
<a title="SATA License" target="_blank" href="https://github.com/zTrix/sata-license">
<img src="https://img.shields.io/badge/license-SATA-green.svg" alt="SATA License">
</a>
</p>
<p align="center">
🇨🇳 中文简体 |
<a title="English" href="README.md">🇬🇧 English</a>
</p>
<p align="center">
<img width="80%" style="border-radius:8px;" src="docs/public/imgs/demo.png" alt="demo.png" border="0" />
</p>
## 文档
一份详细的使用文档,能解决你大部分不清楚地方了🤣
- <https://vitepress-theme-async.imalun.com> (dev)
## 安装
安装 vitepress-theme-async 等插件
```bash
npm install --save vitepress-theme-async
```
或者
```bash
yarn add --save vitepress-theme-async
```
## 更新
你只需要执行:
```bash
npm install vitepress-theme-async@latest
```
## 参与贡献
非常欢迎你的贡献,你可以通过以下方式一起共建 :smiley::
- 遇到 Bug 通过提交 [Issue](https://github.com/MaLuns/vitepress-theme-async/issues) 报告。
- 有建议和疑问欢迎前往 [Discussions](https://github.com/MaLuns/vitepress-theme-async/discussions) 讨论。
- 提交 Pull Request 改进 **vitepress-theme-async** 的代码。
## 协议
本主题采用 [SATA License](https://github.com/zTrix/sata-license)。
> 你不知道这代表什么?简单来说,就是如果你使用了该主题,你需要马不停蹄地点一个 Star,接下来你便可以随意使用它。
## 演示站点
如果你已经使用了本主题,欢迎前往 [Demo Sites | 示例站点 | Discussions](https://github.com/MaLuns/vitepress-theme-async/discussions/7) 留下你的站点,我将会将其添加到下方的示例站点中。
也可以直接修改 [sites.json](https://github.com/MaLuns/vitepress-theme-async/blob/dev/docs/.vitepress/assets/sites.json) 创建 PR。
<!-- demo-start -->
<table>
<tr align="center">
<td>
<a href="https://vitepress-theme-async.imalun.com/demosite/" target="_blank">
<img width="80px" src="https://vitepress-theme-async.imalun.com/logo.svg" />
<br />
<sub title="主题默认示例">默认示例</sub>
</a>
</td>
<td>
<a href="https://www.imalun.com" target="_blank">
<img width="80px" src="https://www.imalun.com/images/avatar.jpg" />
<br />
<sub title="醒,亦在人间;梦,亦在人间。">白云苍狗</sub>
</a>
</td>
</tr>
</table>
<!-- demo-end -->