Skip to content

A command to add Windi CSS to your Svelte project

License

Notifications You must be signed in to change notification settings

moisesbites/windicss

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌬️ Add Windi CSS to Svelte

❓ What is this?

This is an experimental command to run to add Windi CSS to your SvelteKit project or Vite-powered Svelte app.

🧰 Adding to SvelteKit

You must start with a fresh copy of the official SvelteKit template, which is currently created by running this command:

npm init svelte@next

Once that is set up, run this command in your project directory to set up Windi CSS:

npx svelte-add windicss

⚡️ Adding to Vite

You must start with a fresh copy of the official Vite-powered Svelte app template, which is currently created by running this command:

npm init @vitejs/app  # Choose svelte or svelte-ts

Once that is set up, run this command in your project directory to set up Windi CSS:

npx svelte-add windicss

🛠 Usage

After the preset runs,

  • You can use Windi utility classes like bg-blue-700 in the markup (components, routes, app.html).

  • You can configure Windi in the windi.config.cjs file.

  • Your Windi CSS will be purged for production builds.

  • You can apply another Svelte Adder to your project for more functionality.

😵 Help! I have a question

Create an issue and I'll try to help.

😡 Fix! There is something that needs improvement

Create an issue or pull request and I'll try to fix.

These are new tools, so there are likely to be problems in this project. Thank you for bringing them to my attention or fixing them for me.

📄 License

MIT


Repository preview image generated with GitHub Social Preview

This README was generated with ❤️ by readme-md-generator

About

A command to add Windi CSS to your Svelte project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 56.7%
  • Svelte 42.4%
  • JavaScript 0.9%