Skip to main content

Setting up a Pages site with Jekyll

Who can use this feature?

Pages is available in public repositories with Free and Free for organizations, and in public and private repositories with Pro, Team, Enterprise Cloud, and Enterprise Server. For more information, see ’s plans.

Pages now uses Actions to execute the Jekyll build. When using a branch as the source of your build, Actions must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if Actions is unavailable or disabled, adding a .nojekyll file to the root of your source branch will bypass the Jekyll build process and deploy the content directly. For more information on enabling Actions, see Managing Actions settings for a repository.

About Pages and Jekyll

Jekyll is a static site generator with built-in support for Pages.

Creating a Pages site with Jekyll

You can use Jekyll to create a Pages site in a new or existing repository.

Testing your Pages site locally with Jekyll

You can build your Pages site locally to preview and test changes to your site.

Adding content to your Pages site using Jekyll

You can add a new page or post to your Jekyll site on Pages.

Setting a Markdown processor for your Pages site using Jekyll

You can choose a Markdown processor to determine how Markdown is rendered on your Pages site.

Adding a theme to your Pages site using Jekyll

You can personalize your Jekyll site by adding and customizing a theme.

About Jekyll build errors for Pages sites

If Jekyll encounters an error building your Pages site locally or on , you'll receive an error message with more information.

Troubleshooting Jekyll build errors for Pages sites

You can use Jekyll build error messages to troubleshoot problems with your Pages site.