A GitHub Action for building Jekyll sites with custom plugins and deploying them to the gh-pages branch.
jekyll-deploy-gh-pages is a GitHub Action that builds Jekyll sites with custom plugins and deploys them to the gh-pages branch. It solves the limitation of GitHub Pages, which does not support custom Jekyll plugins, by allowing developers to use their own build scripts and gems.
Developers using Jekyll for static site generation who need custom plugins or advanced build configurations and want to deploy via GitHub Pages.
It provides a simple, automated way to deploy Jekyll sites with full plugin support, eliminating the need for manual builds or alternative hosting solutions.
A GitHub Action for building a Jekyll site (with custom plugins) and deploying it back to your gh-pages branch.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Enables the use of any Jekyll plugin or gem, bypassing GitHub Pages' restrictions, as highlighted in the README's motivation for the action.
Clones, builds, and commits directly to the gh-pages branch automatically, reducing manual steps for site updates after pushes.
Integrates seamlessly with GitHub Actions workflows, requiring minimal YAML configuration as shown in the provided example.
Supports custom Gemfile dependencies, allowing precise control over the Jekyll build environment and gem versions.
Requires setting `destination: ./build` in `_config.yml` and maintaining a Gemfile, adding setup complexity and potential for errors.
Only runs on Ubuntu-latest in GitHub Actions, which may not suit projects needing testing or builds on other operating systems.
As a community-maintained action, updates or discontinuation could break workflows, and there's no official support from GitHub.