pelican-tailwindcss 0.4.0

Pelican plugin to add Tailwind CSS to your web site

Tailwind CSS Plugin for Pelican 🌬

This plugin helps you use Tailwind CSS in your Pelican web site.

Why Use This Plugin?

Because you want use Tailwind CSS in seconds. Not hours.

Requirements

This plugin is tested on Tailwind CSS 3.0.24. If you would like to add support for Tailwind CSS 4.0+, please submit a pull request along with appropriate additions to the test suite.

Installation

This plugin can be installed via:

python -m pip install pelican-tailwindcss

As long as you have not explicitly added a PLUGINS setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add tailwindcss to your existing PLUGINS list. For more information, please see the How to Use Plugins documentation.

Basic Usage

1. Create a tailwind.config.js file in your Pelican project root folder containing:

   /** @type {import('tailwindcss').Config} */
   module.exports = {
   content: ["./themes/**/*.html", "./themes/**/*.js"],
   theme: {
       extend: {},
   },
   plugins: [],
   };
   

   The content property values are just suggestions. Feel free to modify them according to your needs.

2. Create a input.css file in your Pelican project root folder containing:

   @tailwind base;
   @tailwind components;
   @tailwind utilities;
   

3. Add the build file (output.css) in your base.html:

   <link rel="stylesheet" href="/output.css" />
   

4. In your Pelican settings, specify the target Tailwind CSS version via the TAILWIND setting:

   TAILWIND = {
       "version": "3.0.24",
   }
   

5. Done! You should be ready to use Tailwind CSS in your web site templates.

Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.

To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.

License

This project is licensed under the AGPL-3.0 license.