Creating a theme for GitHub Pages

On this page

Creating a theme for GitHub Pages#


02 January 2026

For the times when none of the available themes appeal to you, and you craft your own. And then think about putting it out to the world as a shareable remote-theme because, who knows, someone else out there might also be unhappy with the selection on offer, see yours, like it, and use it.

Steps#

  1. Create a public GitHub repo with the following structure:

    |- _layouts
    |  |- default.html
    |- assets
    |  |- style.css
    _config.yml
    LICENSE
    README.md
    
  2. Make sure your _config.yml file has at least a title and a description, like so:

    title: The name of your theme
    description: A sentence or two describing your theme.
    
  3. In the README.md file, ask people to call your theme by creating a _config.yml file in their own repos, and using the following code snippet to reference your theme:

    remote_theme: yourGitHubName/yourRepoName
    plugins:
      - jekyll-remote-theme
    
  4. Check in the files. You’re done.