vac.dev-experimental-old/README.md

32 lines
1.4 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.

# Tailwind Jekyll Starter Kit
A starter kit for using [Tailwind](https://tailwindcss.com) with [Jekyll](https://jekyllrb.com/) that includes:
* A barebones Jekyll starter theme
* A Gulp file with a default task that does the following:
* Builds Tailwind
* Runs [Autoprefixer](https://github.com/postcss/autoprefixer)
* Minifies your CSS
* Builds Jekyll
* Runs [Browsersync](https://www.browsersync.io/) for live reload
## 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/)
* [gulp-cli](https://www.npmjs.com/package/gulp-cli)
* [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 install` to install npm packages
* `gulp` to run the default Gulp task