Test on Archetype

A comprehensive test post showcasing various markdown features, components, and theme capabilities including images, tables, code blocks, and references.
This is a comprehensive test post designed to showcase the various features and capabilities of the PKB theme. It includes multiple markdown elements, components, and formatting options to ensure everything renders correctly. Introduction Welcome to our test archetype! This post demonstrates how different content types render within the theme. From basic text formatting to complex components like tables, code blocks, and mathematical expressionsaa.Sidenotes are particularly useful for additional context without breaking the reading flow.

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.

Hugo Styling Guide

A comprehensive guide to styling your Hugo website
Hugo Styling Guide This guide covers best practices for styling your Hugo website, with a focus on knowledge base themes. CSS Organization in Hugo Hugo offers several approaches to CSS: Resources Pipeline - Process SCSS/SASS files Asset Bundling - Combine and minify CSS CSS Variables - For theme customization For markdown formatting options within your styled site, see our Markdown reference. Theme Components Typography Typography forms the foundation of any knowledge base:

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:

Hugo SEO Implementation Guide

Complete guide to SEO files, configurations, and best practices implemented in the PKB Hugo theme for optimal search engine visibility.
This guide documents all SEO implementations, files, and configurations added to the PKB Hugo theme to ensure optimal search engine visibility and performance. Theme Integration Architecture Hugo Theme SEO Architecture ═══════════════════════════════════════════════════════════════════ ┌─────────────────┐ │ hugo.toml │ │ (Site Config) │ └─────────┬───────┘ │ ┌──────────────┼──────────────┐ │ │ │ ┌───────▼──────┐ ┌────▼────┐ ┌─────▼─────┐ │ data/seo.yml │ │ Content │ │ Static │ │ (SEO Config) │ │ Files │ │ Assets │ └───────┬──────┘ └────┬────┘ └─────┬─────┘ │ │ │ └──────────────┼──────────────┘ │ ┌──────────▼──────────┐ │ LAYOUT SYSTEM │ │ ─────────────────── │ │ baseof.

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.