Skip to content

Latest commit

 

History

History
121 lines (79 loc) · 3.46 KB

README-zh_CN.md

File metadata and controls

121 lines (79 loc) · 3.46 KB

中文 | English

logo

License Stars GitHub last commit GitHub Workflow Status GitHub release (latest by date) Website deployment

Sira 是一个开源、可高度自定义、可访问的设计系统, 目前提供 Tailwindcss 组件库.

我们的主要目标是创建一个可用于构建各种网站和应用程序的系统,同时为终端用户提供一致和包容的用户体验。 此外,设计系统和组件库应易于开发人员和设计者使用。

Sira - Customizable & Accessible Design System provides TWC plugin. | Product Hunt

  • 网站 - 更多关于Sira的信息和文档.
  • 游乐场 - 在 codepen 中快速体验Sira.

功能

  • 品牌自定义
  • 明暗模式主题切换
  • 提供 Tailwindcss 插件

安装

NPM

npm install @sira-ui/tailwind

CDN

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@sira-ui/tailwind/dist/css/styles.css"/>
<script src="https://cdn.tailwindcss.com"></script>

使用

<button class="btn solid success">Success</button>

原理

  • 使用 postcss & tailwind 编译器将基础CSS样式代码(tailwindcss)转换为Tailwindcss插件.
  • 使用CSS组合选择器来组织组件层级样式.
  • 通过根节点的CSS变量储存主题颜色,同时支持CSS层级覆写.

开发

克隆这个仓库

git clone https://github.com/riazer-lab/sira.git

前往项目目录

cd sira

安装依赖

pnpm install

启动开发服务

pnpm run dev

贡献

我们一直欢迎各种贡献参与!

查看 contributing.md 来开始参与贡献.

请遵守本项目的“行为准则”(code of conduct)。

如果您对如何改进本自述文件或项目有什么想法,请告诉我们贡献一些!

技术栈 & 致谢 ♥

感谢以下项目提供了帮助我们创建此项目的依赖和灵感。

  • @riccox/colorify
  • NodeJS
  • TailwindCSS
  • React
  • Nextra
  • TurboRepo
  • Postcss
  • chroma-js
  • Ripple UI
  • daisyUI

反馈

如果你有任何反馈意见建议, 请通过 [email protected] 联系我。

维护者

许可证

Apache License 2.0