vitepress-theme-async/README.md

<h1 align="center">vitepress-theme-async</h1>

<h1 align="center">vitepress-theme-async</h1>

<div align="center">

[Github](https://github.com/MaLuns/vitepress-theme-async) ｜
[Demo](https://vitepress-theme-async.imalun.com/demosite/) ｜
[Preview](https://www.imalun.com) ｜
[Docs](https://vitepress-theme-async.imalun.com/)

A simple & lightweight theme for 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/v14.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">
  🇬🇧 English | 
  <a title="Chinese" href="README_zh-CN.md"> 🇨🇳 中文简体 </a> 
</p>

<p align="center">
  <img width="80%" style="border-radius:8px;" src="docs/public/imgs/demo.png" alt="demo.png" border="0" />
</p>

## Docs

A detailed usage document can solve most of your unclear points 🤣

- <https://vitepress-theme-async.imalun.com>

## Installation

In your blog folder:

```bash
npm install --save vitepress-theme-async
```

or

```bash
yarn add --save vitepress-theme-async
```

## Upgrade

You just need to execute:

```bash
npm install vitepress-theme-async@latest
```

## Contribution

Your contribution is very welcome. You can build it together in the following ways :smiley:

- Use [Issue](https://github.com/MaLuns/vitepress-theme-async/issues) to report bugs or consult.
- Suggestions and questions are welcome to discuss at [Discussions](https://github.com/MaLuns/vitepress-theme-async/discussions).
- Submit Pull Request to improve vitepress-theme-async code.

## License

We use [SATA License](https://github.com/zTrix/sata-license).

> You don’t know what this means? In short, if you use this theme, you need to Star this repo non-stop, and then you can use it anyway you like.

## Demo Sites

If you are using this theme, welcome to leave your site in [Demo Sites | Example Site | Discussions](https://github.com/MaLuns/vitepress-theme-async/discussions/7), and I will add it to the sample site below.

<!-- 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 -->