Article version: GitHub.com

Using a static site generator other than Jekyll

GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server.

You can use a static site generator other than Jekyll for your GitHub Pages site by using a different build process.

GitHub Pages supports any HTML or static files you push to it so you can use any static site generator to build your site. You can even just push raw HTML files to GitHub Pages and it will build your site. You can also customize your own build process locally or on another server.

The main difference between using Jekyll, a popular static site generator with built-in support for GitHub Pages and a different static site generator is the build process. For more information on Jekyll's simplified build process, see "About GitHub Pages and Jekyll."

The build process for non-Jekyll sites

  1. Follow your static site generators' instructions to build your site locally. This may involve pushing your static files to a certain branch.
  2. Your static site generator builds your site locally.
  3. Push the built site's static files to your pages publishing branch (gh-pages or master depending on your site type).
  4. GitHub Pages publishes your site.

Note: If you are using a static site generator other than Jekyll, consult their documentation on how to build your site locally before deploying your site to GitHub Pages. Your static site generator may have some different steps involved in building your site locally.

Ask a human

Can't find what you're looking for?

Contact us