|
||
---|---|---|
_includes | ||
_layouts | ||
src | ||
.babelrc | ||
.gitignore | ||
Gemfile | ||
Gemfile.lock | ||
LICENSE.md | ||
README.md | ||
_config.yml | ||
gulpfile.babel.js | ||
index.html | ||
package-lock.json | ||
package.json | ||
renovate.json | ||
tailwind.config.js |
README.md
Tailwind Jekyll Starter
A starter kit for using Tailwind (v1.0.1) with Jekyll that includes:
-
A barebones Jekyll starter theme
-
A Gulpfile that does the following:
- Compiles Tailwind
- Strips out unused CSS using Purgecss
- Runs Autoprefixer
- Minifies your CSS
- Generate a CSS sourcemap
- Compiles Jekyll
- Runs Browsersync for local development
Example
I used this starter for my personal blog. See the code here.
What is Tailwind?
"Tailwind is a utility-first CSS framework for rapidly building custom user interfaces." –Tailwind
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
Requirements
Get started
bundle install
to install Ruby gemsnpm ci
to install npm packages listed inpackage-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 settingsnpm run build
to compile the site for production
Deploy
Note: By default, Netlify uses jekyll build
as the build command. Make sure to change this to npm run build
.
License
How you can help
Enjoying Tailwind Jekyll and want to help? You can:
- Create an issue with some constructive criticism
- Submit a pull request with some improvements to the project