Documentation Index
Entry point for the PKB-theme documentation notes, organized by subject.
Documentation Index
This note maps the documentation base by subject. Each entry links to a dedicated note, and the glossary defines the technical terms that recur across notes. The notes assume a working Hugo site built with PKB-theme: content creation and theme machinery first, then deployment, then the self-hosted services (analytics, ecommerce) the theme integrates with.
Hugo and theme development
- How the Hugo System Works (2026-07-29): the dated architecture reference for the whole setup: version floor, module and config model, templates, content pipeline, and CI.
- Creating Posts with Hugo: the content workflow, from archetypes and front matter to page bundles.
- Quarto Basics with PKB Theme: authoring and publishing Quarto documents, with the Quarto Test Sample showing a rendered
.qmdpage. - Hugo SEO Implementation Guide: the meta tags, Open Graph, JSON-LD, and sitemap machinery built into the theme.
- Development Tips: day-to-day practices for working on the theme itself.
- SOTA: Hugo Static Site Generator: a fully sourced survey of Hugo through v0.164.0, with an upgrade plan grounded against this theme.
Deployment and hosting
- Hosting Your Hugo Site: hosting-platform comparison and deployment steps.
- Setting up GitHub Pages: first-time GitHub Pages setup for a Hugo site.
- GitHub Pages with Hugo: the Hugo-specific CI build and deploy pipeline.
- Deploying with exampleSite: using the bundled exampleSite as a deployment template.
Analytics
- Self-Hosted Analytics for PKB-theme: choosing and wiring a privacy-friendly analytics backend.
- Analytics Configuration: the theme’s analytics params and supported providers.
- Matomo Analytics Setup Guide: a full Matomo self-hosting walkthrough.
- Reverse Proxy Configuration for Analytics: serving analytics first-party through your own domain.
Ecommerce
- Self-Hosted Ecommerce Solutions: comparison of the store platforms the notes integrate.
- OpenCart Integration Guide: connecting an OpenCart store to the theme.
- PrestaShop Integration Guide: connecting a PrestaShop store to the theme.
- Saleor Integration Guide: connecting a Saleor storefront to the theme.
Theme components
- Color Theme Customization: overriding the theme’s color schemes.
- Gallery Slider Documentation: the gallery-slider shortcode and its options.
- Portfolio Usage: the portfolio content type and its templates (draft, unpublished).
- Text to Speech: the browser-native read-aloud feature and its voice strategy.
