Codeblock Rules

Complete guide to styling and customizing codeblocks in the PKB theme
This guide covers all the ways you can style and customize codeblocks in the PKB theme, from basic syntax highlighting to advanced features like line numbers and copy buttons. Basic Syntax Highlighting The theme supports syntax highlighting for numerous programming languages. Simply specify the language after the opening triple backticks: function greet(name) { console.log(`Hello, ${name}!`); } def fibonacci(n): if n <= 1: return n return fibonacci(n-1) + fibonacci(n-2) package main import "fmt" func main() { fmt.

Gallery Slider Documentation

Complete guide to using the gallery slider component with examples and customization options
The Gallery Slider component provides an elegant way to display multiple images with navigation controls, thumbnails, and captions. This guide covers everything from basic usage to advanced customization. File Organization for Images Understanding how to organize your images is crucial for effective gallery management: Hugo Site Structure ├── static/ │ └── images/ │ ├── docs/ │ │ └── gallery-slider-doc/ │ │ ├── landscape-1.jpg │ │ ├── landscape-2.jpg │ │ ├── portrait-1.

Markdown Boilerplate with Sidenotes

A comprehensive boilerplate showcasing all markdown features and sidenote usage
This document demonstrates all standard Markdown features along with proper sidenote usage. This resource is the central reference for all content creators building a Digital Garden or implementing the Zettelkasten Method. Basic Typography Effective typography forms the foundation of digital writing. As explained by 11., consistent formatting improves readability. Recent studies 22. show that proper formatting significantly impacts user engagement. As demonstrated in previous research 2, this approach has been validated multiple times.

Creating Posts with Hugo

Complete guide to creating new posts and content using Hugo's archetype system
Hugo provides a powerful content creation system using archetypes and the hugo new command. This guide explains how to create different types of content in your PKB-theme site. Understanding Hugo’s Content Structure Hugo organizes content in sections, which correspond to directories under content/. The PKB-theme supports several content types: Posts (content/posts/) - Blog articles and regular content Docs (content/docs/) - Documentation and guides Pages (content/about.md) - Static pages like About, Contact The hugo new Command The basic syntax for creating new content is:

Quarto Basics with PKB Theme

Complete guide to creating and publishing Quarto documents with the PKB theme, including setup, configuration, and best practices.
Quarto is an open-source scientific and technical publishing system that works in HUGO. This guide covers everything you need to know to create/display code outputs from code using a Quarto as integration. What is Quarto? Quarto enables you to weave together content and executable code into a finished document. It supports: Multiple languages: Python, R, Julia, Observable JS Multiple formats: HTML, PDF, MS Word, presentations, websites Interactive elements: Plots, widgets, and dynamic content Academic features: Citations, cross-references, equations Installation and Setup 1.

Quarto Metadata Basics

Complete guide to configuring Quarto document metadata, including YAML front matter, execution options, and PKB theme integration.
Understanding Quarto metadata is crucial for creating well-structured, properly configured documents that integrate seamlessly with the PKB theme. Take into account that to adequately deploy a site with this HUGO, other steps are necessary. This guide covers everything from basic YAML syntax to advanced configuration options for the qmd metadata necessary as a first step. What is Quarto Metadata? Quarto metadata is defined in YAML format at the beginning of your document, enclosed between triple dashes (---).

Development Tips

Development tips and useful commands for PKB-theme development
Development Tips Serving exampleSite For theme development, use this command to serve the exampleSite with debug options: hugo server \ --source exampleSite \ # Point to exampleSite directory --noHTTPCache \ # Disable HTTP caching --renderToMemory \ # Render to memory --disableFastRender \ # Disable fast render --ignoreCache \ # Ignore cache --gc \ # Run garbage collection --logLevel debug \ # Set debug log level -D # Include draft posts Command Explanation --source exampleSite: Serves the example site instead of the main project --noHTTPCache: Prevents browser caching during development --renderToMemory: Renders pages in memory for faster development --disableFastRender: Forces full re-render of changed pages --ignoreCache: Ignores the cache when rebuilding --gc: Runs garbage collection after builds --logLevel debug: Shows detailed debug information -D: Includes draft content Local Testing For production testing, remove debug flags:

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:

Setting up GitHub Pages

A comprehensive guide to set up GitHub Pages with PKB-theme
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 Configure _config.yml Ensure your _config.yml has the correct theme settings: remote_theme: username/PKB-theme 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” Verify Gemfile

Analytics Configuration

Guide for configuring various analytics providers with PKB-theme
Analytics Configuration for PKB-theme This document describes how to configure various self-hosted analytics options for your PKB-theme website. Available Analytics Providers PKB-theme supports the following privacy-focused analytics providers: Matomo (formerly Piwik) Plausible Umami Fathom Lite Shynet Configuration Add the following to your config.toml or hugo.toml file: [params.analytics] # Uncomment and configure the analytics system you want to use # Matomo Analytics # matomo = true # matomoSiteId = "1" # matomoURL = "https://analytics.

Matomo Analytics Setup Guide

Comprehensive guide for setting up Matomo Analytics with your PKB-theme site
Matomo Analytics for PKB-theme This guide provides detailed instructions for integrating Matomo Analytics with your PKB-theme. Matomo is a powerful, privacy-focused alternative to Google Analytics that gives you complete control over your data. Why Choose Matomo? Matomo (formerly Piwik) offers several advantages: Full data ownership: All data stays on your server Privacy compliance: Built-in GDPR, CCPA, and cookie law compliance tools Feature parity: Similar features to Google Analytics No data limits: Analyze unlimited websites and users Customizable: Extensive API and plugin system Installation Options Option 1: Docker Installation (Recommended) Create a docker-compose.

Self-Hosted Analytics for PKB-theme

A comprehensive guide for implementing privacy-focused, FOSS analytics in your PKB-theme site
Self-Hosted Analytics for PKB-theme This guide helps you implement visitor analytics for your PKB-theme using privacy-respecting, FOSS (Free and Open Source Software) solutions. Unlike commercial analytics platforms that collect excessive data and track users across sites, these tools focus on essential metrics while respecting user privacy. Analytics Solutions Comparison Solution Technologies Size Privacy Features Complexity Key Advantages Limitations Plausible Elixir/PostgreSQL <1KB No cookies, GDPR compliant Easy Lightweight script, simple dashboard Limited segmentation compared to Matomo Umami Next.