https://github.com/catppuccin/tailwindcss

💨 Soothing pastel theme for Tailwind CSS
https://github.com/catppuccin/tailwindcss

catppuccin hacktoberfest tailwind tailwindcss theme

Last synced: 2 days ago
JSON representation

💨 Soothing pastel theme for Tailwind CSS

• Host: GitHub
• URL: https://github.com/catppuccin/tailwindcss
• Owner: catppuccin
• License: mit
• Created: 2022-06-15T07:04:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-01T02:40:29.000Z (about 1 year ago)
• Last Synced: 2024-04-14T03:08:27.612Z (7 months ago)
• Topics: catppuccin, hacktoberfest, tailwind, tailwindcss, theme
• Language: TypeScript
• Homepage: https://tailwindcss.catppuccin.com/
• Size: 904 KB
• Stars: 318
• Watchers: 7
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


	


	

	Catppuccin for TailwindCSS

	





    

    

    





  



## Preview

You can check out one of our deployed examples

[here](https://tailwindcss.catppuccin.com)!

## Usage

1. Install the plugin

```sh

$ npm install -D @catppuccin/tailwindcss

# --- or ---

$ yarn add -D @catppuccin/tailwindcss

```

2. Configure your `tailwind.config.js`

```js

module.exports = {

  // ...other settings

  plugins: [require("@catppuccin/tailwindcss")],

};

```

3. _Optional:_ customize the plugin

```js

module.exports = {

  // ...other settings

  plugins: [

    require("@catppuccin/tailwindcss")({

      // prefix to use, e.g. `text-pink` becomes `text-ctp-pink`.

      // default is `false`, which means no prefix

      prefix: "ctp",

      // which flavour of colours to use by default, in the `:root`

      defaultFlavour: "latte",

    }),

  ],

};

```

4. Use it in your markup!

```html

  
Hello world!


```

You can find examples for Next.js, Svelte, and Vite in the `examples` folder.

## 💝 Thanks to

- [winston](https://github.com/nekowinston)

- [Adal Zanabria](https://github.com/AdalZanabria)

 



Copyright © 2021-present Catppuccin Org