website/README.md

50 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2021-07-22 07:13:16 +02:00
# Jekyll + Tailwind CSS
2021-08-30 06:48:22 +02:00
> Minimal Jekyll and Tailwind CSS starter repo without long live-reload render times.
2021-07-17 14:41:01 +02:00
You want to run `jekyll new your-site --blank` and add
2021-07-17 16:34:58 +02:00
[Tailwind CSS](tailwindcss.com) yourself, right?
2021-07-17 14:41:01 +02:00
Dont.
Fork this repo instead.
2022-01-06 07:27:27 +02:00
[Responsive demo](https://jekyll-tailwind.netlify.app/)
(resize your window and watch it adjust)
2021-07-17 18:25:27 +02:00
2022-01-06 07:27:27 +02:00
Check out the accompanying
[blog post](https://stefcoetzee.com/2021/07/28/jekyll-tailwind-starter-repo)
for more.
2021-08-30 06:48:22 +02:00
2021-07-17 18:25:27 +02:00
[![Netlify Status](https://api.netlify.com/api/v1/badges/a22ca4cf-cb1f-4bf3-9fbc-2833226e9b8e/deploy-status)](https://app.netlify.com/sites/jekyll-tailwind/deploys)
2021-07-17 14:41:01 +02:00
## Getting Started
```bash
git clone git@github.com:stefcoetzee/jekyll-tailwind your-site
cd your-site
bin/setup
```
## Usage
### Development
```bash
2022-01-06 07:45:46 +02:00
# Start a live-reload server at http://localhost:4000
2021-07-17 14:41:01 +02:00
bin/start
```
### Production
2022-01-06 07:45:46 +02:00
Note: Delete `.site` and its contents to see the production build output.
2021-07-17 14:41:01 +02:00
```bash
bin/build-prod
```
## Credit
2021-07-17 18:27:50 +02:00
Thanks to [@joemasilotti](https://github.com/joemasilotti) for sharing his build
scripts [here](https://github.com/joemasilotti/masilotti.com/tree/main/bin).
2021-07-17 14:41:01 +02:00
2021-07-17 16:34:58 +02:00
Say hi [@stef_coetzee](https://twitter.com/stef_coetzee)!