website/README.md
2021-07-17 18:24:36 +02:00

48 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Jekyll with Tailwind CSS
You want to run `jekyll new your-site --blank` and add
[Tailwind CSS](tailwindcss.com) yourself, right?
Dont.
Fork this repo instead.
Minimal Jekyll and Tailwind CSS starter repo without long live-reload render times.
## Getting Started
```bash
git clone git@github.com:stefcoetzee/jekyll-tailwind your-site
cd your-site
bin/setup
```
## Usage
### Development
```bash
# Make all Tailwind utility classes available for development.
bin/build-dev
# Start a live-reload server at http://localhost:4000, skipping file with Tailwind
# @import statements during regeneration.
bin/start
```
### Production
Delete `.site` and its contents to see the production build output.
```bash
# Purge unused classes.
bin/build-prod
```
## Credit
Thanks to [@joemasilotti](https://github.com/joemasilotti) for sharing his build
scripts [here](https://github.com/joemasilotti/masilotti.com/tree/main/bin).
Thanks to [@shafy](https://github.com/shafy) for sharing the two config-file
approach [here](https://canolcer.com/post/jekyll-and-tailwind/).
Say hi [@stef_coetzee](https://twitter.com/stef_coetzee)!