Update README.md

This commit is contained in:
Taylor Bryant 2018-12-25 23:15:22 -06:00 committed by GitHub
parent bf4cf52806
commit c26fa7363d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions

View File

@ -1,12 +1,13 @@
# Tailwind Jekyll Starter # Tailwind Jekyll Starter
A starter kit for using [Tailwind](https://tailwindcss.com) (v0.7.3) with [Jekyll](https://jekyllrb.com/) that includes: A starter kit for using [Tailwind](https://tailwindcss.com) (v0.7.3) with [Jekyll](https://jekyllrb.com/) that includes:
* A barebones Jekyll starter theme * A barebones Jekyll starter theme
* A Gulp file with a default task that does the following: * A Gulpfile that does the following:
* Builds Tailwind * Builds Tailwind
* Strips out unused CSS using [Purgecss](http://www.purgecss.com/) * Strips out unused CSS using [Purgecss](http://www.purgecss.com/)
* Runs [Autoprefixer](https://github.com/postcss/autoprefixer) * Runs [Autoprefixer](https://github.com/postcss/autoprefixer)
* Minifies your CSS * Minifies your CSS
* Generate a CSS sourcemap
* Builds Jekyll * Builds Jekyll
* Runs [Browsersync](https://www.browsersync.io/) for live reload * Runs [Browsersync](https://www.browsersync.io/) for live reload
@ -23,7 +24,6 @@ I used this starter for my personal blog. See the code [here](https://github.com
## Requirements ## Requirements
* [Bundler](http://bundler.io/) * [Bundler](http://bundler.io/)
* [gulp-cli](https://www.npmjs.com/package/gulp-cli)
* [Jekyll](https://jekyllrb.com/) * [Jekyll](https://jekyllrb.com/)
* [Node.js](https://nodejs.org/en/) * [Node.js](https://nodejs.org/en/)
* [npm](https://www.npmjs.com/) * [npm](https://www.npmjs.com/)
@ -32,11 +32,11 @@ I used this starter for my personal blog. See the code [here](https://github.com
## Getting started ## Getting started
* `bundle install` to install Ruby gems * `bundle install` to install Ruby gems
* `npm install` to install npm packages * `npm install` to install npm packages
* `npm run start` to run the local development server using BrowserSync * `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:dev` to compile the site with development settings
* `npm run build` to compile the site for production * `npm run build` to compile the site for production
Need your CSS in the `<head>`? Check out the [internal style version](https://github.com/taylorbryant/tailwind-jekyll-internal) of this starter kit.
## License ## License
[MIT](https://github.com/taylorbryant/tailwind-jekyll/blob/master/LICENSE.md) [MIT](https://github.com/taylorbryant/tailwind-jekyll/blob/master/LICENSE.md)