Skip to content

Commit

Permalink
Remove obsolete Tailwind plugin info from README
Browse files Browse the repository at this point in the history
  • Loading branch information
justinmayer committed Feb 24, 2025
1 parent eabb892 commit 77ab18c
Showing 1 changed file with 4 additions and 25 deletions.
29 changes: 4 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ This plugin helps you use [Tailwind CSS][] in your Pelican web site.

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

## Requirements

In order to run this plugin, you need to install Node.JS. (Someday this dependency could be replaced with a Python package.)

## Installation

This plugin can be installed via:
Expand Down Expand Up @@ -48,43 +44,26 @@ As long as you have not explicitly added a `PLUGINS` setting to your Pelican set
@tailwind utilities;
```

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

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

4. Done! You should be ready to use [Tailwind CSS][] in your website template.
4. Done! You should be ready to use [Tailwind CSS][] in your web site templates.

## Advanced Usage

In your settings you can configure the plugin's behavior using the `TAILWIND` setting.
An example of a complete `TAILWIND` setting:
For example, to install and use a specific version of Tailwind CSS:
```python
TAILWIND = {
"version": "3.0.0",
"plugins": [
"@tailwindcss/typography",
"@tailwindcss/forms",
"@tailwindcss/line-clamp",
"@tailwindcss/aspect-ratio",
],
"version": "3.0.20",
}
```
### Tailwind Plugin Installation
As you can see from the example above, it is possible to add the `plugins` property to the configuration.
Just add the name of a Tailwind plugin to the list, and the plugin will be installed.
## Useful Information
### Plugins
Your `tailwind.config.js` file will only be copied when Pelican starts. This means that any changes made after starting Pelican will not be recognized. For example, if you want to install a new plugin for Tailwind, you will have to restart Pelican in order for that plugin to become active.
## 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][].
Expand Down

0 comments on commit 77ab18c

Please sign in to comment.