pelican-tailwindcss 0.1.0

Pelican plugin to add TailwindCSS to your website.

TailwindCSS Plugin for Pelican 🌬

This plugin helps you use TailwindCSS in your Pelican website.

Author	GitHub	Twitter
Luca Fedrizzi	https://github.com/lcfd	https://twitter.com/lc_fd

Why Use This Plugin?

Because you want use TailwindCSS in seconds. Not hours.

Installation

This plugin can be installed via:

python -m pip install pelican-tailwindcss

or

poetry add pelican-tailwindcss

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. Done! You should be ready to use TailwindCSS in your website template.

Advanced Usage

In your settings you can configure the plugin's behavior using the TAILWIND setting.

An example of a complete TAILWIND setting:

TAILWIND = {
    "version": "3.0.0"
}

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.