vite-jekyll

vite Jekyll minimal starter theme

A starter kit for using Sass with Jekyll that includes:

• A barebones Jekyll starter theme

• A Gulp file with a default task that does the following:

  • Builds Sass
  • Runs Autoprefixer
  • Minifies your CSS
  • Builds Jekyll
  • Runs Browsersync for live reload

What is Sass?

"Sass makes CSS fun again. Sass is an extension of CSS, adding nested rules, variables, mixins, selector inheritance, and more. It's translated to well-formatted, standard CSS using the command line tool or a web-framework plugin." – Sass

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
• gulp-cli
• Jekyll
• Node.js
• npm
• Ruby

Get started

• bundle install to install Ruby gems
• npm install to install npm packages
• gulp to run the default Gulp task

Inspired by @taylorbryant's Sass Jekyll Starter.

Installation

Add this line to your Jekyll site's Gemfile:

gem "vite-jekyll"

And add this line to your Jekyll site's _config.yml:

theme: vite-jekyll

And then execute:

$ `bundle exec jekyll serve`

Or install it yourself as:

$ gem install vite-jekyll

Usage

TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in vite-jekyll.gemspec accordingly.

License

The theme is available as open source under the terms of the MIT License.