PKB-theme Demo

Setting up GitHub Pages

1x
Ready

Click anywhere in the title or content to start reading from that position, or use the controls below to play the entire post.

Created:
guides , documentation
github-pages , setup , documentation

Setting up GitHub Pages with PKB-theme

This guide explains how to set up GitHub Pages for your PKB-theme repository.

Important Files

  • _config.yml - Main Jekyll configuration file
  • Gemfile - Ruby dependencies for GitHub Pages
  • index.md - Your homepage content
  • _layouts/ - Theme layout files
  • assets/ - Static files like CSS, images, etc.

Setup Steps

  1. Configure _config.yml

    • Ensure your _config.yml has the correct theme settings:
    remote_theme: username/PKB-theme

  2. Enable GitHub Pages

    • Go to your repository settings
    • Navigate to “Pages” in the sidebar
    • Under “Source”, select:
      • Branch: main (or your preferred branch)
      • Folder: / (root)
    • Click “Save”

  3. Verify Gemfile

    • Make sure your Gemfile includes:
    source 'https://rubygems.org'
gem 'github-pages'

  4. Create Index Page

    • Ensure you have an index.md in your root directory
    • Add front matter to specify layout:
    ---
layout: home
---

Testing Locally

  1. Install dependencies:

    bundle install

  2. Run Jekyll locally:

    bundle exec jekyll serve

  3. Visit http://localhost:4000 to preview your site

Troubleshooting

  • If pages aren’t building, check your repository’s Actions tab
  • Verify your branch and publishing source settings
  • Make sure all required files are committed
  • Check GitHub Pages build logs for errors

Next Steps

After setup, your site will be available at https://username.github.io/PKB-theme/. You can now:

  • Customize your theme
  • Add content to your site
  • Configure additional settings in _config.yml

For more details on GitHub Pages, visit the official documentation.