<p align="center">
  <a href="https://shuimo.design" target="_blank" rel="noopener noreferrer">
    <img width="180" src="https://raw.githubusercontent.com/shuimo-design/shuimo-ui/main/assets/icons/logo.svg" 
        alt="shuimo logo">
  </a>
</p>
<h1 align="center">水墨UI</h1>
<p align="center">一款很粗暴的水墨UI</p>

[![npm](https://img.shields.io/npm/v/shuimo-ui?color=%23c50315&style=flat-square)](https://www.npmjs.com/package/shuimo-ui)
[![codecov](https://codecov.io/gh/shuimo-design/shuimo-ui/graph/badge.svg?token=JYTSFCTMZD)](https://codecov.io/gh/shuimo-design/shuimo-ui)
[![OSCS Status](https://www.oscs1024.com/platform/badge/janghood/shuimo-ui.svg?size=small)](https://www.oscs1024.com/project/janghood/shuimo-ui?ref=badge_small)

[English Document](https://github.com/shuimo-design/shuimo-ui/blob/main/.github/README/README.en.md)

## 简介

这是一款开箱即用的**水墨化**组件库。

我们注意到有许多优秀的企业级UI设计语言和组件库。

作为炎黄子孙，我们十分推崇中国独有的美术风格：水墨。

我们整理出了一套具有中国传统风格的水墨风组件库。

希望这款中国传统风格的组件库，能用于一些小众的需求，能满足于一些对页面有美术追求，又希望能快速搭建的用户。

同时，我们希望能尽一分小小的力量，让更多人了解中国传统文化。

它的实践看起来是这样的：
<img src="https://github.com/shuimo-design/shuimo-ui/blob/main/.github/README/example.webp?raw=true">

## 讨论

[discord](https://discord.gg/xy3BenWvYj)，万年上一次😂。

有需要可以邮件 <a href="mailto:higuaifan@higuaifan.com">higuaifan@higuaifan.com</a> 联系我 _（以及加入微信小群）_。

### 安装

```bash
npm install shuimo-ui
```

### 文档

[点击这里](https://shuimo.design)

## 周边

我们发现`水墨UI`的设计风格可以用于一些有趣的地方，因此我们产出了一些周边，正在逐步迭代与发布中。

当前我们能与您分享的，是一套水墨风壁纸。

这里是项目链接：[shuimo-wallpaper](https://github.com/shuimo-design/wallpaper)

## 支持者

<img width="180" src="https://raw.githubusercontent.com/shuimo-design/shuimo-ui/main/.github/README/jetbrains.svg" alt="jetbrains logo">

十分感谢 [`Jetbrains`](https://www.jetbrains.com/) 提供给我们的开源开发许可证。

## 贡献

[贡献指南](https://github.com/shuimo-design/shuimo-ui/blob/main/.github/contributing.md)
