Skip to content

spellbooks/jekyll-boilerplate

Repository files navigation

Jekyll Boilerplate

A clean boilerplate to kickstart client-side sites using Jekyll, Vite, Stimulus.js, and Tailwind CSS.
Ideal for blogs, documentation sites, personal landing pages or portfolio.

easy deploy on githubpages, netlify, vercel (based client-side)

Jekyll using version 4.4.1

Information

Stimulus controllers are located in _app/javascript/controllers/**

Tailwind input _app/stylesheets/application.css

Tailwind build output _app/build/application.css

Prerequisites

  • Ruby
  • Node

Installation

Clone this repo or

via Gem Sylvia

gem install sylvia

then

sylvia jekyll new_app

Setup and Usage

Install Dependencies

bundle install && npm install

Run Jekyll Development Server

rake dev

the command running jekyll, vite and tailwindcss

open localhost:4000

Run Rspec Testing

rake test

Generate html Layout

rake layout[test]

make new file 'test.html in _layouts

Generate Controller Stimulus

rake stimulus[test]

make new file 'test_controller.js in _app/javascript/controllers

Build js using vite

rake build

file build in _app/build/application.js

Run Jekyll Production Sever

rake p

Showcase

list jekyll site using this template

License

MIT License

Credits

Created by whdzera

Feel free to fork, improve, or contribute via pull requests!