https://github.com/timonweb/django-tailwind

Django + Tailwind CSS = 💚
https://github.com/timonweb/django-tailwind

css django django-tailwind tailwind tailwind-css

Last synced: about 14 hours ago
JSON representation

Django + Tailwind CSS = 💚

• Host: GitHub
• URL: https://github.com/timonweb/django-tailwind
• Owner: timonweb
• License: mit
• Created: 2019-04-11T19:49:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T13:57:57.000Z (2 months ago)
• Last Synced: 2024-09-22T14:02:17.602Z (3 days ago)
• Topics: css, django, django-tailwind, tailwind, tailwind-css
• Language: Python
• Homepage: https://django-tailwind.readthedocs.io
• Size: 6.1 MB
• Stars: 1,445
• Watchers: 18
• Forks: 88
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

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

![Django Tailwind Demo](https://raw.githubusercontent.com/timonweb/django-tailwind/master/docs/django-tailwind-demo-800.gif)

## 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](https://timonweb.com/django/django-tailwind-with-support-for-the-latest-tailwind-css-v3-is-out/).

## 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:

```bash

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:

 ```bash

 pip install 'django-tailwind[reload]'

 ```

Check docs for the [Installation](https://django-tailwind.readthedocs.io/en/latest/installation.html) instructions.

## Bugs and suggestions

Please see [CONTRIBUTING](CONTRIBUTING.md).

2019 - 2023 (c) [Tim Kamanin - A Full Stack Django Developer](https://timonweb.com)