Jekyllist is a production ready boilerplate for humans who wants to build simple websites (portfolio sites, basic landing pages, coming soon templates) with the modern tech stack.
- 🔥 Jekyll for Static Site Generator
- 🎨 Integrated with Tailwind CSS (with PurgeCSS and JIT)
- 💅 PostCSS for processing Tailwind CSS
- ⚡️ Lazy load images with lazysizes
- ✨ Compress image with Imagemin
- ✏️ Linter with StyleLint
- 🛠 Code Formatter with Prettier
- 💨 Live reload with Browsersync
- 📦 Module Bundler with [Laravel Mix]https://laravel-mix.com)
- ✅ Cache busting
- 💯 Maximize lighthouse score
At the time I decided to develop this boilerplate, I was looking for a simple and lightweight static site generators for building my personal portfolio website. I came across with Jekyll but I had no luck to find a great boilerplate template that adapted modern tech stacks. So I created this boilerplate in mind:
- Minimal code (HTML, CSS & JS). Add what you need
- Easy assets management (Images, SVG Icons, Fonts)
- Tidy partials (Snippets, template parts)
- Speed optimized
- SEO-friendly
- 🚀 Production-ready
Before using this boilerplate, please follow the official Jekyll guideline to setup Jekyll on your local machine.
- Ruby version 2.5.0 or higher
- Bundler
- Jekyll
- Node.js
- Yarn
Run the following command on your local environment:
git clone --depth=1 https://github.com/atakanoz/jekyllist.git ./my-project-name \
cd my-project-name \
bundle install && yarn
Then, you can run locally in development mode with live reload:
yarn dev
You can see the results locally in production mode with:
yarn build
The generated HTML and CSS files are minified. It will also removed unused CSS from Tailwind CSS.
You can create an optimized production build with:
npm run build:production
Now, your blog is ready to be deployed. All generated files are located at _site folder, which you can deploy with any hosting service.
Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.
Licensed under the MIT License, Copyright © 2022
See LICENSE for more information.
Made with ♥ by Atakan Oz