KiSite

A lightweight tool to view and share your KiCad projects online.

Built on KiCanvas, KiSite scans for KiCad project files and generates a static site.

See the demo here.

Features

• Out-of-the-box support for hosting with GitHub Pages
• Shareable location markers (e.g. in GitHub issues and PR reviews)
• Download links for each project
• Basic support for inline documentation

Usage

Configuration

Create kisite-config.json in the root directory:

{
  "title": "My KiCad Projects",
  "projectDirs": ["projects"]
}

| Field | Description | Default | | ------------- | --------------------------------------------------- | --------------- | | title | Displayed as site title | Repository name | | projectDirs | Array of directories containing KiCad project files | ["projects"] |

Deployment

GitHub Pages

After enabling GitHub Pages in your repository settings, add the following GitHub workflow:

name: Build and Deploy KiSite

on:
  push:
    branches: [main]
  workflow_dispatch:

# Sets permissions for GitHub Pages deployment
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6
        with:
          submodules: recursive

      - name: Setup Node.js
        uses: actions/setup-node@v6
        with:
          node-version: "24"

      - run: npm install [email protected]
      - run: npm exec kisite build

      - name: Setup Pages
        uses: actions/configure-pages@v4

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: "./dist"

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

See the demo workflow for a complete example.

Manual Build

Install the KiSite CLI:

npm install -g kisite

Build site:

npm exec kisite build

Alternatively, run the development server:

npm exec kisite dev

Future Work

• GitLab hosting
• Improved inline documentation (e.g. per sheet, component links, etc.)
• KiCad plugin for viewing PR comments and markers locally
• Support for custom themes and site customization
• Improved workspace layout
• 3D renderings
• Diff view and PR support

Alternatives

• KiCAD-PRISM
  • KiCAD-PRISM provides a more comprehensive backend for design reviews and collaboration, but requires self-hosting and maintenance