Skip to content

Fix README typos and css_path config key #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vormwald wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix README typos and css_path config key #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d49aa72
docs: fix README typos and css_path config key
vormwald Aug 16, 2026
e2e13bf
style: fix standardrb Style/EmptyStringInsideInterpolation offenses
vormwald Aug 16, 2026
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,24 +143,24 @@ This file acts as your tailwind configuration file. Import "tailwindcss" and any

**File 2: `./assets/css/styles.tailwindcss`**

Place this file wherever you'd like your site's tailwind CLI generated content to go: `assets/css/your_css_file.tailwindcss` -> `__site/assets/css/your_css_file.css`
Place this file wherever you'd like your site's tailwind CLI generated content to go: `assets/css/your_css_file.tailwindcss` -> `_site/assets/css/your_css_file.css`

It must contain yaml frontmatter to be processed by Jekyll [^1]

```yaml
---
# This file will be converted to __site/assets/css/styles.css
# This file will be converted to _site/assets/css/styles.css
---
This file is just a placeholder. It's content will be replaced by output from the tailwindcss CLI.
This file is just a placeholder. Its content will be replaced by output from the tailwindcss CLI.
```

> [!NOTE]
> Why the 2 files?
>
> This is a compromise to allow the [TailwindCSS intellisense](https://tailwindcss.com/docs/editor-setup#intellisense-for-vs-code) plugin to work. (It cannot parse a CSS file with frontmatter, so we keep it seperate)
> This is a compromise to allow the [TailwindCSS intellisense](https://tailwindcss.com/docs/editor-setup#intellisense-for-vs-code) plugin to work. (It cannot parse a CSS file with frontmatter, so we keep it separate)
>
> The `_tailwind.css` file serves as the tailwindcss config file.
> If you'd rather set keep this file somewhere else, you can do so by setting the `tailwindcss.config_file` option in `_config.yml`:
> If you'd rather keep this file somewhere else, you can do so by setting the `tailwindcss.css_path` option in `_config.yml`:
>
> ```yaml
> tailwindcss:
Expand Down
2 changes: 1 addition & 1 deletion lib/jekyll/converters/css.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def convert(content)
end

dev_mode = Jekyll.env == "development"
Jekyll.logger.info "Jekyll Tailwind:", "Generating #{dev_mode ? "" : "minified "}CSS"
Jekyll.logger.info "Jekyll Tailwind:", "Generating #{"minified " unless dev_mode}CSS"

compile_command = ::Tailwindcss::Commands
.compile_command(debug: dev_mode, config_path: config_path, postcss_path: postcss_path)
Expand Down
2 changes: 1 addition & 1 deletion lib/jekyll/converters/tailwindcss.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ def convert(content)
end

dev_mode = Jekyll.env == "development"
Jekyll.logger.info "Jekyll Tailwind:", "Generating #{dev_mode ? "" : "minified "}CSS"
Jekyll.logger.info "Jekyll Tailwind:", "Generating #{"minified " unless dev_mode}CSS"

compile_command = ::Tailwindcss::Commands
.compile_command(debug: dev_mode)
Expand Down
Loading