Skip to content

Overview

This is a demo site for the hugo-kicad-site theme — a reusable Hugo theme for KiCad hardware project documentation. Built on top of Hextra.

It uses the Arduino Uno Shield template from KiCad as example content. All assets (3D renders, BOM, interactive BOM, schematics) are generated automatically by KiBot during CI.

What this theme provides

  • Board page — embedded KiCanvas viewer for interactive schematic/PCB browsing, 3D render gallery, interactive BOM
  • Release page — combined downloads, schematic/PCB diffs, and GitHub release link
  • Assembly page — interactive 3D model viewer (STEP/GLB via Online3DViewer)
  • Custom composition — embed any viewer in plain Markdown via the call-partial shortcode
  • Version picker — switch between tagged releases (Read the Docs style)
  • Dark/light mode — automatic system detection, synced across all viewers

Composable pages

Instead of fixed page types, you can compose pages freely using shortcodes:

{{< call-partial "kicanvas.html" >}}
{{< call-partial "gallery.html" >}}
{{< call-partial "ibom.html" >}}
{{< call-partial "assembly.html" >}}
{{< call-partial "bom.html" >}}
{{< call-partial "diffs.html" >}}
{{< call-partial "diffs-pdf.html" >}}
{{< call-partial "download-list.html" >}}

See the Custom Composition page for a live example.

KiBot outputs

All assets on this site were generated by KiBot from the KiCad source files. Browse the raw KiBot outputs here:

📂 Browse all KiBot outputs

Real-world example

See Granit for a full-featured project using this theme with KiBot-generated assets including Blender renders, visual diffs, and mechanical assembly models.