timonweb / django-tailwind

Django + Tailwind CSS = 💚

Tailwind CSS integration for Django a.k.a. Django + Tailwind = 💚

Goal

This project aims to provide a comfortable way of using the Tailwind CSS framework within a Django project.

Features

• An opinionated Tailwind CSS setup that makes your life easier;
• Hot reloading of CSS, configuration files, and Django templates. No more manual page refreshes!
• Out of the box support for CSS imports, SASS-like variables, and nesting;
• Includes official Tailwind CSS plugins like typography, form, line-clamp, and aspect-ratio;
• Supports the latest Tailwind CSS v3.x;

For instructions on upgrading from v2 to v3, see this post on my blog.

Requirements

Python 3.10 or newer with Django >= 3.2 or newer.

Documentation

The full documentation is at https://django-tailwind.readthedocs.io/

Installation

Via PIP:

pip install django-tailwind

[RECOMMENDED IN DEV] If you want to use automatic page reloads during development use the [reload] extras, which installs the django-browser-reload package in addition:

pip install 'django-tailwind[reload]'

Check docs for the Installation instructions.

Bugs and suggestions

Please see CONTRIBUTING.

2019 - 2023 (c) Tim Kamanin - A Full Stack Django Developer