2019-08-19 17:36:50 +00:00
# Jekyll Starter Tailwind
2019-05-16 13:14:56 +00:00
[](#contributors)
2019-05-16 13:12:17 +00:00
2019-07-17 02:26:07 +00:00
A starter kit for using [Tailwind ](https://tailwindcss.com ) with [Jekyll ](https://jekyllrb.com/ ) that includes:
2017-11-09 02:09:42 +00:00
* A barebones Jekyll starter theme
2018-12-26 05:15:22 +00:00
* A Gulpfile that does the following:
2017-11-09 02:09:42 +00:00
2018-12-26 05:15:58 +00:00
* Compiles Tailwind
2020-05-02 00:10:06 +00:00
* Strips out unused CSS using Tailwind's `purge` option
2017-11-09 02:12:40 +00:00
* Runs [Autoprefixer ](https://github.com/postcss/autoprefixer )
2017-11-09 02:09:42 +00:00
* Minifies your CSS
2018-12-26 05:15:58 +00:00
* Compiles Jekyll
* Runs [Browsersync ](https://www.browsersync.io/ ) for local development
2018-11-06 16:57:51 +00:00
2017-11-09 02:09:42 +00:00
## What is Tailwind?
2017-11-09 02:13:18 +00:00
>"Tailwind is a utility-first CSS framework for rapidly building custom user interfaces."
2018-12-26 05:17:18 +00:00
–
2017-11-09 02:09:42 +00:00
## What is Jekyll?
2017-11-09 02:13:18 +00:00
>"Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories."
2018-12-26 05:17:18 +00:00
–
2017-11-09 02:41:49 +00:00
2018-11-06 16:57:51 +00:00
## Requirements
2017-11-12 05:09:14 +00:00
* [Bundler ](http://bundler.io/ )
2017-11-15 00:52:58 +00:00
* [Jekyll ](https://jekyllrb.com/ )
2017-11-12 05:09:14 +00:00
* [Node.js ](https://nodejs.org/en/ )
* [npm ](https://www.npmjs.com/ )
2017-11-15 00:52:58 +00:00
* [Ruby ](https://www.ruby-lang.org/en/ )
2017-11-12 05:09:14 +00:00
2019-03-23 17:08:34 +00:00
## Get started
2017-11-09 02:41:49 +00:00
* `bundle install` to install Ruby gems
2018-12-26 05:16:42 +00:00
* `npm ci` to install npm packages listed in `package-lock.json`
2020-01-25 18:35:18 +00:00
* `npm run start` or `npm run dev` to compile the site with development settings and run BrowserSync
2018-12-26 05:15:22 +00:00
## Build your site
2018-11-06 16:57:51 +00:00
* `npm run build:dev` to compile the site with development settings
2020-02-08 19:35:51 +00:00
* `npm run build:production` or `npm run build` to compile the site for production
2017-11-22 03:28:56 +00:00
2019-03-20 06:41:36 +00:00
## Deploy
2019-08-20 00:12:57 +00:00
[](https://app.netlify.com/start/deploy?repository=https://github.com/taylorbryant/jekyll-starter-tailwind)
2019-03-20 06:41:36 +00:00
2020-05-09 02:22:52 +00:00
Note: By default, Netlify uses `jekyll build` as the build command. The included `netlify.toml` file will override it to use `npm run build` .
2019-03-20 06:46:00 +00:00
2017-12-01 07:58:01 +00:00
## License
2019-08-20 00:12:57 +00:00
[MIT ](https://github.com/taylorbryant/jekyll-starter-tailwind/blob/master/LICENSE.md )
2019-03-20 06:04:00 +00:00
## How you can help
2019-08-20 00:12:57 +00:00
Enjoying Jekyll Starter Tailwind and want to help? You can:
* [Create an issue ](https://github.com/taylorbryant/jekyll-starter-tailwind/issues/new ) with some constructive criticism
* [Submit a pull request ](https://github.com/taylorbryant/jekyll-starter-tailwind/compare ) with some improvements to the project
2019-05-16 13:11:47 +00:00
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
2020-05-09 16:03:16 +00:00
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
< td align = "center" > < a href = "http://phproberto.com" > < img src = "https://avatars0.githubusercontent.com/u/1119272?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Roberto Segura< / b > < / sub > < / a > < br / > < a href = "https://github.com/taylorbryant/jekyll-starter-tailwind/commits?author=phproberto" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/benmp" > < img src = "https://avatars3.githubusercontent.com/u/9081154?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > benmp< / b > < / sub > < / a > < br / > < a href = "https://github.com/taylorbryant/jekyll-starter-tailwind/commits?author=benmp" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://github.com/jd4no" > < img src = "https://avatars0.githubusercontent.com/u/15043675?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Joey Defourneaux< / b > < / sub > < / a > < br / > < a href = "https://github.com/taylorbryant/jekyll-starter-tailwind/commits?author=jd4no" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://shime.sh" > < img src = "https://avatars3.githubusercontent.com/u/703563?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Hrvoje Šimić< / b > < / sub > < / a > < br / > < a href = "https://github.com/taylorbryant/jekyll-starter-tailwind/commits?author=shime" title = "Code" > 💻< / a > < / td >
< td align = "center" > < a href = "https://alejof.dev" > < img src = "https://avatars2.githubusercontent.com/u/7116453?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Alejandro Figueroa< / b > < / sub > < / a > < br / > < a href = "https://github.com/taylorbryant/jekyll-starter-tailwind/commits?author=alexphi" title = "Code" > 💻< / a > < / td >
< / tr >
< / table >
<!-- markdownlint - enable -->
<!-- prettier - ignore - end -->
2019-05-16 13:11:47 +00:00
<!-- ALL - CONTRIBUTORS - LIST:END -->
2019-05-16 13:12:17 +00:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!
