vac.dev-experimental-old/README.md

# Tailwind Jekyll Starter
[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)

A starter kit for using [Tailwind](https://tailwindcss.com) (v1.0.3) with [Jekyll](https://jekyllrb.com/) that includes:
* A barebones Jekyll starter theme
* A Gulpfile that does the following:

    * Compiles Tailwind
    * Strips out unused CSS using [Purgecss](http://www.purgecss.com/)
    * Runs [Autoprefixer](https://github.com/postcss/autoprefixer)
    * Minifies your CSS
    * Generate a CSS sourcemap
    * Compiles Jekyll
    * Runs [Browsersync](https://www.browsersync.io/) for local development

## Example
I used this starter for my personal blog. See the code [here](https://github.com/taylorbryant/taylorbryant.github.io).

## What is Tailwind?
>"Tailwind is a utility-first CSS framework for rapidly building custom user interfaces."
–[Tailwind](https://tailwindcss.com)

## What is Jekyll?
>"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."
–[Jekyll](https://jekyllrb.com/)

## Requirements
* [Bundler](http://bundler.io/)
* [Jekyll](https://jekyllrb.com/)
* [Node.js](https://nodejs.org/en/)
* [npm](https://www.npmjs.com/)
* [Ruby](https://www.ruby-lang.org/en/)

## Get started
* `bundle install` to install Ruby gems
* `npm ci` to install npm packages listed in `package-lock.json`
* `npm run start` to compile the site with development settings and run BrowserSync

## Build your site
* `npm run build:dev` to compile the site with development settings
* `npm run build` to compile the site for production


## Deploy
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/taylorbryant/tailwind-jekyll)

Note: By default, Netlify uses `jekyll build` as the build command. Make sure to change this to `npm run build`.

## License
[MIT](https://github.com/taylorbryant/tailwind-jekyll/blob/master/LICENSE.md)

## How you can help
Enjoying Tailwind Jekyll and want to help? You can:
* [Create an issue](https://github.com/taylorbryant/tailwind-jekyll/issues/new) with some constructive criticism
* [Submit a pull request](https://github.com/taylorbryant/tailwind-jekyll/compare) with some improvements to the project

## 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 -->
<!-- prettier-ignore -->
<table><tr><td align="center"><a href="http://phproberto.com"><img src="https://avatars0.githubusercontent.com/u/1119272?v=4" width="100px;" alt="Roberto Segura"/><br /><sub><b>Roberto Segura</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/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="benmp"/><br /><sub><b>benmp</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/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="Joey Defourneaux"/><br /><sub><b>Joey Defourneaux</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/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="Hrvoje Šimić"/><br /><sub><b>Hrvoje Šimić</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/commits?author=shime" title="Code">💻</a></td></tr></table>

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
-												Shorten title
											
										
										
											2017-11-22 22:24:49 +00:00
+								# Tailwind Jekyll Starter
-												docs: update README.md
											
										
										
											2019-05-16 13:14:56 +00:00
+								[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)
-												Update README.md
											
										
										
											2019-05-16 13:12:17 +00:00
-												Update README.md
											
										
										
											2019-06-04 19:40:56 +00:00
+								A starter kit for using [Tailwind](https://tailwindcss.com) (v1.0.3) with [Jekyll](https://jekyllrb.com/) that includes:
-												Update README.md
											
										
										
											2017-11-09 02:09:42 +00:00
+								* A barebones Jekyll starter theme
-												Update README.md
											
										
										
											2018-12-26 05:15:22 +00:00
+								* A Gulpfile that does the following:
-												Update README.md
											
										
										
											2017-11-09 02:09:42 +00:00
-												Update README.md
											
										
										
											2018-12-26 05:15:58 +00:00
+								    * Compiles Tailwind
-												Update copy to reflect Purgecss update
											
										
										
											2018-02-09 05:17:13 +00:00
+								    * Strips out unused CSS using [Purgecss](http://www.purgecss.com/)
-												Update README.md
											
										
										
											2017-11-09 02:12:40 +00:00
+								    * Runs [Autoprefixer](https://github.com/postcss/autoprefixer)
-												Update README.md
											
										
										
											2017-11-09 02:09:42 +00:00
+								    * Minifies your CSS
-												Update README.md
											
										
										
											2018-12-26 05:15:22 +00:00
+								    * Generate a CSS sourcemap
-												Update README.md
											
										
										
											2018-12-26 05:15:58 +00:00
+								    * Compiles Jekyll
 								    * Runs [Browsersync](https://www.browsersync.io/) for local development
-												Updated gulp tasks and npm scripts to provide multiple task configs.

Added more gulp tasks to allow for a serve, build:dev, and build task.

Added npm scripts to trigger the different gulp tasks.

Heavy tasks, like purging and minifying, will now only be done for production builds.

											
										
										
											2018-11-06 16:57:51 +00:00
-												Update README.md
											
										
										
											2018-09-02 00:06:14 +00:00
+								## Example
 								I used this starter for my personal blog. See the code [here](https://github.com/taylorbryant/taylorbryant.github.io).
-												Update README.md
											
										
										
											2017-11-09 02:09:42 +00:00
 								## What is Tailwind?
-												Update README.md
											
										
										
											2017-11-09 02:13:18 +00:00
+								>"Tailwind is a utility-first CSS framework for rapidly building custom user interfaces."
-												Update README.md
											
										
										
											2018-12-26 05:17:18 +00:00
+								–[Tailwind](https://tailwindcss.com)
-												Update README.md
											
										
										
											2017-11-09 02:09:42 +00:00
 								## What is Jekyll?
-												Update README.md
											
										
										
											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."
-												Update README.md
											
										
										
											2018-12-26 05:17:18 +00:00
+								–[Jekyll](https://jekyllrb.com/)
-												Update README.md
											
										
										
											2017-11-09 02:41:49 +00:00
-												Updated gulp tasks and npm scripts to provide multiple task configs.

Added more gulp tasks to allow for a serve, build:dev, and build task.

Added npm scripts to trigger the different gulp tasks.

Heavy tasks, like purging and minifying, will now only be done for production builds.

											
										
										
											2018-11-06 16:57:51 +00:00
+								## Requirements
-												Add requirements
											
										
										
											2017-11-12 05:09:14 +00:00
+								* [Bundler](http://bundler.io/)
-												Add Jekyll to list of requirements

											
										
										
											2017-11-15 00:52:58 +00:00
+								* [Jekyll](https://jekyllrb.com/)
-												Add requirements
											
										
										
											2017-11-12 05:09:14 +00:00
+								* [Node.js](https://nodejs.org/en/)
 								* [npm](https://www.npmjs.com/)
-												Add Jekyll to list of requirements

											
										
										
											2017-11-15 00:52:58 +00:00
+								* [Ruby](https://www.ruby-lang.org/en/)
-												Add requirements
											
										
										
											2017-11-12 05:09:14 +00:00
-												Update README.md
											
										
										
											2019-03-23 17:08:34 +00:00
+								## Get started
-												Update README.md
											
										
										
											2017-11-09 02:41:49 +00:00
+								* `bundle install` to install Ruby gems
-												Update README.md
											
										
										
											2018-12-26 05:16:42 +00:00
+								* `npm ci` to install npm packages listed in `package-lock.json`
-												Update README.md
											
										
										
											2018-12-26 05:15:22 +00:00
+								* `npm run start` to compile the site with development settings and run BrowserSync
 								## Build your site
-												Updated gulp tasks and npm scripts to provide multiple task configs.

Added more gulp tasks to allow for a serve, build:dev, and build task.

Added npm scripts to trigger the different gulp tasks.

Heavy tasks, like purging and minifying, will now only be done for production builds.

											
										
										
											2018-11-06 16:57:51 +00:00
+								* `npm run build:dev` to compile the site with development settings
 								* `npm run build` to compile the site for production
-												Update README.md
											
										
										
											2017-11-22 03:28:56 +00:00
-												Update README.md
											
										
										
											2019-03-20 06:41:36 +00:00
 								## Deploy
 								[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/taylorbryant/tailwind-jekyll)
-												Update README.md
											
										
										
											2019-03-20 06:46:00 +00:00
+								Note: By default, Netlify uses `jekyll build` as the build command. Make sure to change this to `npm run build`.
-												Update README.md
											
										
										
											2017-12-01 07:58:01 +00:00
+								## License
-												Update README.md
											
										
										
											2017-12-01 08:13:45 +00:00
+								[MIT](https://github.com/taylorbryant/tailwind-jekyll/blob/master/LICENSE.md)
-												Update README.md
											
										
										
											2019-03-20 06:04:00 +00:00
 								## How you can help
-												Update README.md
											
										
										
											2019-03-20 06:04:24 +00:00
+								Enjoying Tailwind Jekyll and want to help? You can:
-												Update README.md
											
										
										
											2019-03-20 06:04:00 +00:00
+								* [Create an issue](https://github.com/taylorbryant/tailwind-jekyll/issues/new) with some constructive criticism
 								* [Submit a pull request](https://github.com/taylorbryant/tailwind-jekyll/compare) with some improvements to the project
-												docs: update README.md
											
										
										
											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 -->
 								<!-- prettier-ignore -->
-												docs: update README.md
											
										
										
											2019-05-16 13:14:56 +00:00
+								<table><tr><td align="center"><a href="http://phproberto.com"><img src="https://avatars0.githubusercontent.com/u/1119272?v=4" width="100px;" alt="Roberto Segura"/><br /><sub><b>Roberto Segura</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/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="benmp"/><br /><sub><b>benmp</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/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="Joey Defourneaux"/><br /><sub><b>Joey Defourneaux</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/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="Hrvoje Šimić"/><br /><sub><b>Hrvoje Šimić</b></sub></a><br /><a href="https://github.com/Oddstronaut/tailwind-jekyll/commits?author=shime" title="Code">💻</a></td></tr></table>
-												docs: update README.md
											
										
										
											2019-05-16 13:11:47 +00:00
 								<!-- ALL-CONTRIBUTORS-LIST:END -->
-												Update README.md
											
										
										
											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!