PinConnect turns a photo of a circuit board into an interactive pinout diagram: hover or tap a connector and its pin names, colors, and description appear. The result is a single HTML file you can open in a browser, share, or embed in a documentation site.
There are two ways of generating pinouts with it:
In the browser. Open the designer, load a board image, draw a box over each connector, label the pins, and press Generate. Nothing to install. Start with Getting Started.
From the command line. pinout-gen renders the same file from a saved config, which is what you want for regenerating pinouts as a board changes, or in a CI job that publishes a docs site. See Automating.
- Getting Started: from a board image to a finished pinout, in the browser.
- The designer: a full tour, keyboard shortcuts, and what to do when something goes wrong.
- Concepts: how the pieces fit together, and the three kinds of TOML file.
- Automating: install the command line tool, regenerate pinouts, and publish from CI.
- Embedding: put a pinout into an MkDocs or Zensical page.
- Board TOML: every field in a board config.
- Connector types: the built-in library, and adding your own.
- Themes: colors, fonts, and layout behavior, and writing your own theme.