Skip to content
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
suppport to tailwind cli postcss, contributing tips
  • Loading branch information
muriloime committed Feb 7, 2023
commit dd3e0eb6d0bf06b24aa268a8fc341f439582a899
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ If you are running `rails tailwindcss:watch` as a process in a Docker container,
If you are running `rails tailwindcss:watch` on a system that doesn't fully support file system events, pass a `poll` argument to the task to instruct tailwindcss to instead use polling: `rails tailwindcss:watch[poll]`. If you use `bin/dev` then you should modify your `Procfile.dev`.


### Use postcss
### Using postcss

In the case you want to use postcss plugins you will need to pass postcss option like `rails tailwindcss:build[postcss]` or `rails tailwindcss:watch[postcss]`.
The tailwind cli supports passing a postcss.config.js file. This might be necessary if you want to use postcss plugins (e.g. postcss-css-variables). In this case you can pass postcss as a task option `rails tailwindcss:build[postcss]` or `rails tailwindcss:watch[postcss]`.

### Debugging with unminified assets

Expand Down Expand Up @@ -151,6 +151,14 @@ The inline version also works:
<section class="bg-[url('image.svg')]">Has the image as it's background</section>
```

### Contributing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a CONTRIBUTING.md file which I think covers this topic. If not, please make changes to that file and not the user-facing README.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added content addressing how to develop against this gem in e22c8ce


If you want to fork this repo and test this gem locally in your projects, you will need to run `rake package` (the process this gem uses to generate platform-related gem versions, e.g. x86_64-linux, x86_64-darwin, etc). You can now point the local version of the gem in your Gemfile:

```ruby
gem 'tailwindcss-rails', '2.0.18', path: '/path/to/your/local/gem'
```

## License

Tailwind for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).
Expand Down