Improved Markdown tester

A comprehensive boilerplate showcasing all markdown features and sidenote usage
This document demonstrates all standard Markdown features along with proper sidenote usage. Sidenotes work great with lists to provide additional context for specific items without breaking the list flow. For more information about building effective knowledge bases, check out Building a Personal Knowledge Base. Basic Typography Sidenotes work great with lists to provide additional context for specific items without breaking the list flow. 11. Bold text and italic text are straightforward.

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:

Content Organization Guide

Best practices for organizing your digital content and knowledge base
Content Organization Guide Effective content organization is crucial for any knowledge management system. This guide covers best practices for structuring your digital content. For proper formatting of all elements in this guide, refer to our comprehensive Markdown Boilerplate. Hierarchical vs. Network Organization Traditional organization is hierarchical (folders and subfolders), but knowledge bases benefit from a network approach with bidirectional links. See our Markdown Boilerplate for examples of proper linking syntax.

Saleor Integration Guide

Developer-focused guide for implementing and integrating Saleor headless commerce platform with your PKB-theme project
Setting Up Saleor with PKB-theme This guide provides detailed instructions for developers to install, configure, and integrate Saleor - a modern, GraphQL-first headless commerce platform - with your PKB-theme knowledge base or blog. Introduction to Saleor Saleor is a headless e-commerce platform built with Python, Django, and GraphQL. Unlike traditional e-commerce systems, Saleor separates the backend (data and business logic) from the frontend (user interface), allowing for more flexible and customizable implementations.

PrestaShop Integration Guide

Comprehensive guide for installing and integrating PrestaShop with your PKB-theme project
Setting Up PrestaShop with PKB-theme This guide walks you through the process of installing, configuring, and integrating PrestaShop with your PKB-theme knowledge base or blog site. Prerequisites Before beginning the installation, ensure your environment meets these requirements: Web server (Apache, Nginx) with PHP 7.4+ (PHP 8.0+ recommended) MySQL 5.6+ or MariaDB 10.0+ PHP extensions: GD, cURL, SimpleXML, DOM, Zip, PDO, and Mcrypt At least 250MB of disk space Server memory limit of at least 256MB FTP or SSH access to your server Database credentials Installation Process Step 1: Server Preparation Create a dedicated subdomain (recommended) or subdirectory for your store:

OpenCart Integration Guide

Step-by-step guide for setting up and integrating OpenCart with your PKB-theme project
Setting Up OpenCart with PKB-theme This guide provides comprehensive instructions for installing, configuring, and integrating OpenCart with your knowledge base or blog built with PKB-theme. Prerequisites Before beginning the installation, ensure you have: Web server with PHP 7.3+ and MySQL 5.6+ cURL and ZIP PHP extensions enabled At least 100MB of disk space FTP or SSH access to your server Database credentials Ability to create subdomains or subdirectories Installation Process Step 1: Prepare Your Server Environment Create a dedicated subdomain (recommended) or subdirectory for your store:

Self-Hosted Ecommerce Solutions

A comprehensive guide to self-hosted and open-source ecommerce platforms for creating independent online stores
Self-Hosted Ecommerce Solutions This guide introduces privacy-respecting, self-hosted alternatives to commercial ecommerce platforms. These Free and Open Source Software (FOSS) solutions give you complete control over your online store without vendor lock-in or excessive fees. Why Choose Self-Hosted Ecommerce? Self-hosting your ecommerce platform offers several advantages: Complete Ownership: Full control over your store’s data, appearance, and functionality Privacy Focused: No third-party tracking or data collection unless you choose to add it No Revenue Sharing: Avoid platform fees that take a percentage of each sale Unlimited Customization: Modify any aspect of your store’s code to match your exact requirements Scalability Options: Scale your infrastructure as your business grows Integration Freedom: Connect with any payment processor, shipping provider, or third-party service Community Support: Access large communities of developers and store owners Ecommerce Solutions Comparison Solution Technology Features Complexity Scalability Freemium Aspects Best For License WooCommerce WordPress/PHP Extensive Low-Medium Medium Core is free, many premium extensions Small-Medium businesses already using WordPress GPLv3 PrestaShop PHP/MySQL Comprehensive Medium Medium-High Free core, marketplace primarily offers paid modules Small-Medium businesses in Europe OSL 3.

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:

Reverse Proxy Configuration for Analytics

A comprehensive guide for setting up reverse proxies for self-hosted analytics solutions
Reverse Proxy Setup for Self-Hosted Analytics This guide explains how to properly configure reverse proxies for your self-hosted analytics solutions. A reverse proxy sits between users and your analytics server, providing benefits like SSL termination, load balancing, and additional security. Comparison of Reverse Proxy Solutions Solution Ease of Config Performance Features SSL Support Auto Config Best For Nginx Medium Excellent Extensive Manual config No High-traffic sites, complex setups Caddy Very Easy Good Good Automatic HTTPS Yes Beginners, quick setup Traefik Medium Very Good Extensive Automatic HTTPS Yes Container environments HAProxy Complex Excellent Advanced Manual config No High availability, load balancing Apache Medium Good Extensive Manual config No Compatibility with existing Apache setups General Setup Principles When setting up a reverse proxy for analytics, consider these key principles:

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.