https://github.com/spellbooks/jekyll-template-starter
A sleek starter client-side site template for efficient boilerplate with Jekyll, Vite, Stimulus, and Tailwind.
https://github.com/spellbooks/jekyll-template-starter
jekyll jekyll-site stimulus stimulusjs tailwind tailwindcss vite
Last synced: about 1 year ago
JSON representation
A sleek starter client-side site template for efficient boilerplate with Jekyll, Vite, Stimulus, and Tailwind.
- Host: GitHub
- URL: https://github.com/spellbooks/jekyll-template-starter
- Owner: spellbooks
- Created: 2025-06-09T21:58:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-14T23:55:49.000Z (about 1 year ago)
- Last Synced: 2025-06-15T00:20:11.665Z (about 1 year ago)
- Topics: jekyll, jekyll-site, stimulus, stimulusjs, tailwind, tailwindcss, vite
- Language: Ruby
- Homepage:
- Size: 6.04 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jekyll Starter
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.
I built this template to make Jekyll competitive with Astro.
Jekyll using version `4.4.1`
Stimulus configuration `app/javascript/application.js`
Stimulus controllers are located in `app/javascript/controllers/**`
Tailwind input `app/assets/stylesheets/tailwind.css`
Tailwind builds to `app/assets/stylesheets/application.css`
- [Jekyll](https://jekyllrb.com/)
- [Vite](https://vite.dev/)
- [Stimulus.js](https://stimulus.hotwired.dev/)
- [Tailwind CSS](https://tailwindcss.com/)
---
## Structure
## Prerequisites
- Ruby 3.0^
- Node 2.2^
## Installation
#### 1. Clone the Repository
```bash
git clone https://github.com/spellbooks/jekyll-template-starter.git
cd jekyll-template-starter
```
#### 2. Install Dependencies
```bash
bundle install && npm install
```
#### 3. Run the Development Server
```bash
rake dev
```
the command running jekyll, vite and tailwindcss
open `localhost:4000`
#### 4. Run Rspec Testing
```bash
rake test
```
#### 5. Generate Controller Stimulus
`hello is example`
```bash
rake stimulus[hello]
```
make new file 'hello_controller.js in `app/javascript/controllers`
added import and register hello controller in `app/javascript/application.js`
#### 6. Build js using vite
```bash
rake build
```
file build in `app/build/application.js`
#### 7. Run Jekyll Sever Production
```bash
rake p
```
## Gists
Automation Generate new Project jekyll use this template
https://gist.github.com/whdzera/aefad9ae560df32adfb7848e0bad28f2
## License
MIT License
#### Credits
Created by `whdzera`
Feel free to fork, improve, or contribute via pull requests!