Embed
Put your board on any web page.
Paste a GitHub repository with a KiCad or PCBKit board. Get it as a live 3D frame for your site or docs, or as a picture for a README, a post or a slide, and copy the HTML, the address or the Markdown. Free, no account, nothing stored.
Try
That doesn’t look like a GitHub repository. Paste its address, like github.com/foostan/crkbd.
How it works
One frame of the real app.
The frame is PCBKit itself, drawn by its own renderer: the reader turns the board, lifts its layers apart, plays its AI tour, switches to 2D or goes fullscreen, and the board’s name opens it in the app. Any public repository works, plain KiCad projects included.
| Address | Shows |
|---|---|
/embed/github/owner/repo | a public repository’s board, its default branch |
/embed/github/owner/repo/tree/ref/path | a branch, tag or commit, a folder of it |
/embed/demo/slug | a board of PCBKit’s library |
/embed/s/id | a board shared by link, following its author’s changes |
| Option | Does |
|---|---|
?explode | the layers apart, like panes of glass |
?tour | the AI tour plays once the board is open |
?view=2d | open in 2D (3D by default) |
?ui=minimal | only the name and Tour over the board; ui=none: the name alone |
?mask=red | another solder mask colour (black by default; mask=board: the board’s own) |
?theme=light | a light ground (dark by default); ?grid=0 hides the grid |
| Picture | Does |
|---|---|
.webp, .png | the frame’s address with an extension: a picture of the board |
?shape=wide | 16:9; square, social (1.91:1); 4:3 by default |
?size=l | 2400 wide; s 480, m 1200 by default |
?theme=light | a light background (dark by default) |
?mask=…&explode=1&grid=0 | the mask colour, the layers apart, no grid |
A picture of a pinned commit is drawn once and kept; its first drawing takes a few seconds. GitHub allows 60 reads an hour per reader without a sign-in, and a frame takes three. Private repositories do not open in a frame. Pin a commit (/tree/<sha>) to show a board as it was. The story behind it: on the blog.