Skip to main content

Develop with Tailwind CSS in Django flavour.

Project description

English | 中文

django-tailwindcss

Develop with Tailwind CSS in Django flavour.

Quick Start

1. Install django-tailwindcss from pip

pip install django-tailwindcss

2. Download Tailwind CSS CLI file and create tailwind.config.js

CLI file can be download from https://github.com/tailwindlabs/tailwindcss/releases

tailwind.config.js can be found at https://tailwindcss.com/docs/installation

Example:

module.exports = {
  content: ["./**/*.{html,js}"],
  theme: {
    extend: {},
  },
  plugins: [],
}

Store tailwindcss-linux-x64 (for linux) and tailwind.config.js at the same directory of manage.py.

And your project proj should be like:

proj
├── proj
│   └── settings.py
├── manage.py
├── tailwindcss-linux-x64
└── tailwind.config.js

3. Add tailwindcss to your settings.INSTALLED_APPS

INSTALLED_APPS = [
    ...
    "tailwindcss",
    ...
]

4. Create these variables in your settings

# BASE_DIR = Path(__file__).resolve().parent

TAILWINDCSS_CLI_FILE = BASE_DIR / 'tailwindcss-linux-x64'
TAILWINDCSS_CONFIG_FILE = BASE_DIR / 'tailwind.config.js'

5. Use tailwindcss tag in your base template

{% load tailwindcss %}
<html>
  <head>
    ...
    {% tailwindcss %}
    ...
  </head>
  ...
</html>

Internal

django-tailwindcss generates CSS each time django startup and file changes.

And {% tailwindcss %} outputs are same as:

<style>/*! tailwindcss v3.0.23 | MIT License | https://tailwindcss.com*/*,:after,:before{border:0 solid #e5e7eb;box-sizing:border-box}...</style>

So you usually only need to add it once.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-tailwindcss-0.2.2.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

django_tailwindcss-0.2.2-py3-none-any.whl (4.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page