vac.dev-experimental-old/README.md

Jekyll Starter Tailwind

A starter kit for using Tailwind 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

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

• Bundler
• Jekyll
• Node.js
• npm
• Ruby

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

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

License

MIT

How you can help

Enjoying Jekyll Starter Tailwind and want to help? You can:

• Create an issue with some constructive criticism
• Submit a pull request with some improvements to the project

Contributors

Thanks goes to these wonderful people (emoji key):

Roberto Segura 💻

benmp 💻

Joey Defourneaux 💻

Hrvoje Šimić 💻

This project follows the all-contributors specification. Contributions of any kind welcome!