https://github.com/spellbooks/jekyll-boilerplate
A Jekyll boilerplate with (Vite, Stimulus.js, and Tailwind)
https://github.com/spellbooks/jekyll-boilerplate
jekyll jekyll-site stimulus stimulusjs tailwind tailwindcss vite
Last synced: about 2 months ago
JSON representation
A Jekyll boilerplate with (Vite, Stimulus.js, and Tailwind)
- Host: GitHub
- URL: https://github.com/spellbooks/jekyll-boilerplate
- Owner: spellbooks
- Created: 2025-06-09T21:58:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-09T18:43:26.000Z (9 months ago)
- Last Synced: 2025-09-09T22:30:38.116Z (9 months ago)
- Topics: jekyll, jekyll-site, stimulus, stimulusjs, tailwind, tailwindcss, vite
- Language: Ruby
- Homepage:
- Size: 6.05 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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`
- [Jekyll](https://jekyllrb.com/)
- [Vite](https://vite.dev/)
- [Stimulus.js](https://stimulus.hotwired.dev/)
- [Tailwind CSS](https://tailwindcss.com/)
## 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
```bash
bundle install && npm install
```
#### Run Jekyll Development Server
```bash
rake dev
```
the command running jekyll, vite and tailwindcss
open `localhost:4000`
#### Run Rspec Testing
```bash
rake test
```
#### Generate html Layout
```bash
rake layout[test]
```
make new file 'test.html in `_layouts`
#### Generate Controller Stimulus
```bash
rake stimulus[test]
```
make new file 'test_controller.js in `_app/javascript/controllers`
#### Build js using vite
```bash
rake build
```
file build in `_app/build/application.js`
#### Run Jekyll Production Sever
```bash
rake p
```
## Showcase
list jekyll site using this template
- https://whdzera.github.io -> blog site
- https://whdzera.github.io/totp -> TOTP Management
- https://whdzera.github.io/todolist -> ToDoList
- https://whdzera.github.io/calc -> Calculator
- https://whdzera.github.io/strikethrough -> Strikethrough Text Generator
- https://whdzera.github.io/findanime -> Find Anime by image
- https://whdzera.github.io/xiAnimelist -> Animelist
## License
MIT License
#### Credits
Created by `whdzera`
Feel free to fork, improve, or contribute via pull requests!