Skip to content

Commit

Permalink
Relocate Tailwind automation to a separate repository
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredcwhite committed Aug 14, 2022
1 parent adbbbe0 commit 22427a4
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions bridgetown-website/src/_docs/bundled-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ The configurations we include are:
- [Ruby2JS](#ruby2js) (`ruby2js`)
- [Bridgetown recommended PostCSS plugins](#bridgetown-recommended-postcss-plugins) (`bt-postcss`)
- [PurgeCSS Post-Build Hook](#purgecss-post-build-hook) (`purgecss`)
- [TailwindCSS](#tailwindcss) (`tailwindcss`)
- [Render YAML Configuration](#render-yaml-configuration) (`render`)
- [Netlify TOML Configuration](#netlify-toml-configuration) (`netlify`)
- [Vercel JSON Configuration](#vercel-json-configuration) (`vercel`)
Expand All @@ -40,6 +39,12 @@ Bundled configurations can also be run while creating a new Bridgetown project u
Keep reading for documentation on all those options.
{% end %}

{%@ Note type: :warning do %}
#### Looking for Tailwind?

The bundled configuration for TailwindCSS has been [relocated to a separate community-maintained repo](https://github.com/bridgetownrb/tailwindcss-automation). The installation process remains just as simple. However, the Bridgetown core team recommends looking into options such as Open Props, Shoelace, and otherwise "vanilla" CSS (perhaps with a bit of help from PostCSS or Sass) as a best practice for "Use the Platform", future-compatible frontend development.
{% end %}

## Configuration Setup Details

### Turbo
Expand Down Expand Up @@ -142,20 +147,6 @@ If you'd like to customize your setup further you can find more plugins [here](h
bin/bridgetown configure purgecss
```

### TailwindCSS

🍃 Adds [TailwindCSS](https://tailwindcss.com) for utility class-based prototyping and layout.

Please be aware that you need to have [PostCSS](https://postcss.org) installed to run this configuration.

This configuration will overwrite any existing `postcss.config.js` file. **NOTE:** you do not need to install the PurgeCSS hook as Tailwind now uses a JIT (Just-In-Time) compiler to add only the styles it needs based on your source files.

🛠 **Configure using:**

```sh
bin/bridgetown configure tailwindcss
```

### Render YAML Configuration

⚙️ Adds a static site service defined in YAML to your site for use in [Render](https://render.com) deployments.
Expand Down

0 comments on commit 22427a4

Please sign in to comment.