Skip to content

kjaymiller/render-engine-tailwindcss

Repository files navigation

Render Engine TailwindCSS Plugin

Add tailwindcss to your Render Engine site.

TailwindCSS is a utility-first CSS framework for rapidly building custom designs.

The pytailwindcss package is used to install compile the tailwindcss stylesheets without the need of npm.

This plugin installs builds a tailwindcss file from the default configuration and adds a tailwind.css file to your static files.

Warning: This is in early development.

Installation

Install the extension with pip:

pip install render-engine-tailwindcss

Usage

  1. Import the plugin.

    # app.py
    
    from render_engine import Site
    from render_engine_tailwindcss import TailwindCSS
  2. Add the plugin to your site.

    # app.py
    
    class site(Site):
    
        static_path = 'static'
        plugins=[
            TailwindCSS(),
        ]
    
    )
  3. In your 'static_path', add your pre-tailwindcss stylesheets.

    # static/styles.css
    
    @tailwind base;
    @tailwind components;
    @tailwind utilities; 

You can add multiple CSS files to the static path and they will all converted into their own files.

Development & Testing

This project uses just for common development tasks and nox for testing across multiple Python versions.

Quick Start with Just

# Run tests
just test

# Run tests with coverage
just test-coverage

# Run both (if available)
just check

Using Nox for Multi-Version Testing

Test the plugin across Python 3.11, 3.12, 3.13, and 3.14:

# Run tests on all Python versions
nox -s test

# Run all checks
nox -s check

Development Setup

# Install with uv (recommended)
uv sync

# Install with pip
pip install -e ".[test]"

# Run tests
just test

Available Just Commands

  • just test - Run pytest on current Python version
  • just test-coverage - Run pytest with coverage reporting
  • just check - Run tests

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •