vac.dev-experimental-old/README.md

43 lines
2.0 KiB
Markdown
Raw Normal View History

2017-11-22 22:24:49 +00:00
# Tailwind Jekyll Starter
2018-12-25 07:13:48 +00:00
A starter kit for using [Tailwind](https://tailwindcss.com) (v0.7.3) with [Jekyll](https://jekyllrb.com/) that includes:
2017-11-09 02:09:42 +00:00
* A barebones Jekyll starter theme
* A Gulp file with a default task that does the following:
* Builds Tailwind
2018-02-09 05:17:13 +00:00
* Strips out unused CSS using [Purgecss](http://www.purgecss.com/)
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
2017-11-09 02:12:40 +00:00
* Builds Jekyll
* Runs [Browsersync](https://www.browsersync.io/) for live reload
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).
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."
[Tailwind](https://tailwindcss.com)
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."
[Jekyll](https://jekyllrb.com/)
2017-11-09 02:41:49 +00:00
## Requirements
2017-11-12 05:09:14 +00:00
* [Bundler](http://bundler.io/)
* [gulp-cli](https://www.npmjs.com/package/gulp-cli)
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
2018-03-25 19:43:43 +00:00
## Getting started
2017-11-09 02:41:49 +00:00
* `bundle install` to install Ruby gems
* `npm install` to install npm packages
* `npm run start` to run the local development server using BrowserSync
* `npm run build:dev` to compile the site with development settings
* `npm run build` to compile the site for production
2017-11-22 03:28:56 +00:00
2017-11-23 19:48:43 +00:00
Need your CSS in the `<head>`? Check out the [internal style version](https://github.com/taylorbryant/tailwind-jekyll-internal) of this starter kit.
2017-12-01 07:58:01 +00:00
## License
2017-12-01 08:13:45 +00:00
[MIT](https://github.com/taylorbryant/tailwind-jekyll/blob/master/LICENSE.md)