https://github.com/joeybeninghove/jetset

Jekyll Starter Kit
https://github.com/joeybeninghove/jetset

jekyll stimulusjs tailwind tailwindcss webpack

Last synced: about 2 months ago
JSON representation

Jekyll Starter Kit

• Host: GitHub
• URL: https://github.com/joeybeninghove/jetset
• Owner: joeybeninghove
• Created: 2019-01-05T02:26:26.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T04:06:52.000Z (about 2 years ago)
• Last Synced: 2024-10-02T09:54:09.043Z (3 months ago)
• Topics: jekyll, stimulusjs, tailwind, tailwindcss, webpack
• Language: JavaScript
• Homepage: https://joey.io
• Size: 2.91 MB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 25
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jekyll-fun

In kind of a spin-off of [fun](https://github.com/joeybeninghove/fun), this is a

[Jekyll](https://jekyllrb.com/) starter kit that can be used to quickly build

out a production-ready Jekyll static site.

## Features

* [Webpack](https://webpack.js.org/) for managing all of the assets

* [Tailwind](https://tailwindcss.com/) baked in for utility-first CSS

* [Stimulus](https://stimulusjs.org/) as a lightweight javascript framework

* [PostCSS](https://github.com/postcss/postcss) used to load Tailwind and make

    [postcss-import](https://github.com/postcss/postcss-import) and

    [postcss-preset-env](https://github.com/csstools/postcss-preset-env) available

    to use

* [BrowserSync](https://www.browsersync.io/) for live reloading of browser after

    code changes

* [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) for generating SEO

    tags

* [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) for generating a

    sitemap

## Setup

1. `bundle install`

2. `yarn install`

## Directory Structure

### `_src`

All of the CSS, JS and images are stored in the `_src` directory, which is

managed by Webpack.

## Usage

1. `rake serve`

2. `yarn dev`

Alternatively, if you have [foreman] installed, you can `foreman start` and both the web and webpack instances will be started.

## The Process

When Webpack runs, it compiles all of the assets into the `/assets` directory

and then generates the base layout to `_layouts/base.html` with the appropriate

`` and `` tags injected into it.