GitHub Pages with Hugo

How to deploy your PKB-theme site to GitHub Pages using Hugo
Deploying to GitHub Pages with Hugo This guide explains how to deploy your PKB-theme site to GitHub Pages using Hugo’s built-in capabilities. Prerequisites Hugo Extended version installed Git repository initialized GitHub account PKB-theme installed as a submodule Configuration Steps Update config.toml baseURL = "https://username.github.io/repository-name/" theme = "PKB-theme" publishDir = "docs" # Required for GitHub Pages Create GitHub Workflow Create .github/workflows/hugo.yml: name: Deploy Hugo site on: push: branches: - main jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: submodules: true fetch-depth: 0 - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: hugo-version: 'latest' extended: true - name: Build run: hugo --minify - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.

Deploying with exampleSite

Guide for deploying your site using PKB-theme's exampleSite as a template
Deploying with exampleSite The PKB-theme includes an exampleSite directory that serves as both a demo and a template for your own site. Quick Start Copy exampleSite Contents cp -r themes/PKB-theme/exampleSite/* . Update Configuration Edit config.toml: baseURL = "https://your-username.github.io/your-site/" title = "Your Site Title" theme = "PKB-theme" Customize Content Modify content in content/ directory Update images in static/ directory Adjust layouts in layouts/ if needed Directory Structure The exampleSite provides a complete structure: