1 | <h1 align="center">
|
2 | <a href="https://github.com/windicss/windicss/wiki">
|
3 | <img src="https://next.windicss.org/assets/logo.svg" alt="Windi CSS Logo" height="120" width="120"/><br>
|
4 | </a>
|
5 | Windi CSS
|
6 | <br/>
|
7 | +
|
8 | </h1>
|
9 | <h5 align="center">WindiCSS Web APIs for Browsers.</h5>
|
10 | <h5 align="center">Check out APIs <a href="#APIs">here</a> untill it available on official WindiCSS.</h5>
|
11 |
|
12 | <p align="center">
|
13 | <a href="https://www.npmjs.com/package/windicss"><img src="https://img.shields.io/npm/v/windicss.svg?color=0EA5E9" alt="Npm Version"></a>
|
14 | <a href="https://www.npmjs.com/package/windicss"><img src="https://img.shields.io/npm/dt/windicss.svg?color=1388bd" alt="Total Downloads"></a>
|
15 | <a href="https://github.com/windicss/windicss/actions"><img src="https://img.shields.io/github/workflow/status/windicss/windicss/Node.js%20CI" alt="Build Status"></a>
|
16 | <a href="https://codecov.io/gh/windicss/windicss"><img src="https://img.shields.io/codecov/c/github/windicss/windicss/dev.svg?sanitize=true" alt="Coverage"></a>
|
17 | <br>
|
18 | <a href="https://discord.gg/aRYWm8r8Eq"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord&logoColor=white&label=&color=7289da" alt="Discord Chat"></a>
|
19 | <br>
|
20 | </p>
|
21 |
|
22 | <p align="center">Next generation utility-first CSS framework.</p>
|
23 |
|
24 | <p align="center">
|
25 | If you are already familiar with Tailwind CSS, think about Windi CSS as an <b>on-demanded</b> alternative to Tailwind, which provides faster load times, <b>fully compatible with Tailwind v2.0</b> and with a bunch of additional cool features.
|
26 | </p>
|
27 |
|
28 | [windi css]: https://windicss.org
|
29 | [website]: https://windicss.org
|
30 | [video comparison]: https://twitter.com/antfu7/status/1361398324587163648
|
31 |
|
32 | ## Why Windi CSS? π€
|
33 |
|
34 | A quote from the author should illustrate his motivation to create [Windi CSS]:
|
35 |
|
36 | > When my project became larger and there were about dozens of components, the initial compilation time reached 3s, and hot updates took more than 1s with Tailwind CSS. - [@voorjaar](https://github.com/voorjaar)
|
37 |
|
38 | By scanning your HTML and CSS and generating utilities on demand, [Windi CSS] is able to provide [faster load times][video comparison] and a speedy HMR in development, and does not require purging in production.
|
39 |
|
40 | Read more about it in the [Introduction](https://windicss.org/guide/).
|
41 |
|
42 | ## Integrations
|
43 |
|
44 | Windi CSS provides first-class integrations for your favorite tools, select yours and get started.
|
45 |
|
46 | | Frameworks | Package | Version |
|
47 | | :-- | :-- | :-- |
|
48 | | CLI | [Built-in](https://windicss.org/guide/cli) | ![](https://img.shields.io/npm/v/windicss?label=&color=0EA5E9) |
|
49 | | VSCode Extension | [windicss-intellisense](https://github.com/windicss/windicss-intellisense) | ![](https://img.shields.io/visual-studio-marketplace/v/voorjaar.windicss-intellisense.svg?label=&color=1388bd) |
|
50 | | Vite | [vite-plugin-windicss](https://github.com/windicss/vite-plugin-windicss) | ![](https://img.shields.io/npm/v/vite-plugin-windicss?label=&color=0EA5E9) |
|
51 | | Rollup | [rollup-plugin-windicss](https://github.com/windicss/vite-plugin-windicss/tree/main/packages/rollup-plugin-windicss) | ![](https://img.shields.io/npm/v/rollup-plugin-windicss?label=&color=1388bd) |
|
52 | | Webpack | [windicss-webpack-plugin](https://github.com/windicss/windicss-webpack-plugin) | ![](https://img.shields.io/npm/v/windicss-webpack-plugin?label=&color=1388bd) |
|
53 | | Nuxt | [nuxt-windicss](https://github.com/windicss/nuxt-windicss-module) | ![](https://img.shields.io/npm/v/nuxt-windicss-module?label=&color=1388bd) |
|
54 | | Svelte | [svelte-windicss-preprocess](https://github.com/windicss/svelte-windicss-preprocess) | ![](https://img.shields.io/npm/v/svelte-windicss-preprocess?label=&color=1388bd) |
|
55 | | StencilJS | [stencil-windicss](https://github.com/codeperate/stencil-windicss)<sup>Community</sup> | ![](https://img.shields.io/npm/v/@codeperate/stencil-windicss?label=&color=1388bd) |
|
56 | | Web APIs | [Web-APIs]()<sup>Community</sup> | 0.2.2 |
|
57 |
|
58 | <div id="APIs"></div>
|
59 |
|
60 | ## CDN Links for Browser/JavaScipt IIFE APIs π
|
61 |
|
62 | - config: [https://unpkg.com/windicss-with-web-api@0.2.2/dist/config/index.iife.js](https://unpkg.com/windicss-with-web-api@0.2.2/dist/config/index.iife.js).
|
63 | - helpers: [https://unpkg.com/windicss-with-web-api@0.2.2/dist/helpers/index.iife.js](https://unpkg.com/windicss-with-web-api@0.2.2/dist/helpers/index.iife.js).
|
64 | - lib: [https://unpkg.com/windicss-with-web-api@0.2.2/dist/lib/index.iife.js](https://unpkg.com/windicss-with-web-api@0.2.2/dist/lib/index.iife.js).
|
65 | - plugin: [https://unpkg.com/windicss-with-web-api@0.2.2/dist/plugin/index.iife.js](https://unpkg.com/windicss-with-web-api@0.2.2/dist/plugin/index.iife.js).
|
66 | - utils: [https://unpkg.com/windicss-with-web-api@0.2.2/dist/utils/index.iife.js](https://unpkg.com/windicss-with-web-api@0.2.2/dist/utils/index.iife.js).
|
67 | #### Example Links [Live WindCSS in browser compilation]
|
68 |
|
69 |
|
70 | - **HTML demo link:** https://codesandbox.io/s/html-windicss-live-playground-b2kbh
|
71 | - **React demo link:** https://codesandbox.io/s/react-windicss-live-playground-5j7xr
|
72 |
|
73 | **UNPKG CDN link:** https://unpkg.com/browse/windicss-with-web-api@0.2.2/
|
74 |
|
75 | ## Plugins π
|
76 |
|
77 | Check out [plugins available for windicss](https://github.com/windicss/plugins).
|
78 |
|
79 | ## Documentation π
|
80 |
|
81 | Check [the documentation website][website].
|
82 |
|
83 | ## Discussions
|
84 |
|
85 | Weβre using [GitHub Discussions](https://github.com/windicss/windicss/discussions) as a place to connect with other members of our community. You are free to ask questions and share ideas, so enjoy yourself.
|
86 |
|
87 | ## Contributing
|
88 |
|
89 | If you're interested in contributing to windicss, please read our [contributing docs](https://github.com/windicss/windicss/blob/main/CONTRIBUTING.md) **before submitting a pull request**.
|
90 |
|
91 | ## Sponsors
|
92 |
|
93 | <a href="https://opencollective.com/windicss" target="_blank">
|
94 | <img src="https://opencollective.com/windicss/sponsors.svg">
|
95 | </a>
|
96 |
|
97 | ## Backers
|
98 | <a href="https://opencollective.com/windicss" target="_blank">
|
99 | <img src="https://opencollective.com/windicss/backers.svg">
|
100 | </a>
|
101 |
|
102 | ## License
|
103 |
|
104 | Distributed under the [MIT License](https://github.com/windicss/windicss/blob/main/LICENSE).
|