Styleguide

This page exists so authors (human or agent) can see every component in context. It doubles as the visual QA page — if something looks wrong here, it looks wrong everywhere.

Prose

Regular paragraphs are muted. Strong text pops to primary. Inline code like splithttp.DialerClient gets a chip. Links to the source are underlined.

• Unordered lists use blook’s dot markers
• Second item, with inline code
• Third item

1. Ordered lists get bold counters
2. And they nest properly

Blockquotes render as quiet surface cards — good for quoting comments straight from the Go source.

Callouts

Use callouts for exactly the things this site exists for — the non-obvious behavior you only learn by reading the source:

Do / Don’t

Pages follow the Refactoring UI pattern: a principle in one sentence, then a concrete example. For configuration advice, that example is a Do/Don’t pair:

Source references

Tag sections with the files they were derived from:

Code

Go, with the poimandres theme on a surface card:

// DialerClient reuses one HTTP client per destination — uploads are
// individual POSTs, the download is one long-lived GET.
func (c *DefaultDialerClient) OpenUpload(ctx context.Context, baseURL string) io.WriteCloser {
	reader, writer := io.Pipe()
	req, _ := http.NewRequestWithContext(ctx, "POST", baseURL, reader)
	go c.client.Do(req)
	return writer
}

Config JSON:

{
	"network": "xhttp",
	"xhttpSettings": {
		"mode": "packet-up",
		"path": "/assets"
	}
}

Diagrams

Svelte Flow diagrams with blook-styled nodes. Node kinds: client (blue), server (lime), net (dashed), process (neutral), danger (red). Edges can be labeled and animated.

Tables