Skip to content

style: GitHub-style Open Graph cards for the docs site - #44

Merged
joeblau merged 1 commit into
mainfrom
style/github-style-og-cards
Sep 30, 2026
Merged

joeblau merged 1 commit into
mainfrom
style/github-style-og-cards

Conversation

@joeblau

@joeblau joeblau commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

Simplifies the docs site's social (Open Graph) cards to GitHub's repository-card layout.

  • White card. The home card shows bloxwap/**chart** with the site description. Page cards show a small bloxwap/chart · Guides line (or API reference, Documentation, Playground) above a bold page title, with the page description in grey.
  • Bloxwap mark top right, in the slot where GitHub puts the owner avatar.
  • Footer facts in GitHub's stats style: v0.2.0 Latest · MIT License · 0 Dependencies. They're read from packages/chart/package.json when the cards are generated, so each release updates them.
  • Brand palette bar (green, blue, purple, pink, yellow) along the bottom edge, in place of GitHub's language bar.
  • Removed: the black canvas, the per-page colour rail, the wordmark header and the 148px Nunito Black headlines.

The card descriptions use a regular weight, so apps/docs/fonts/ gains Nunito-Regular.ttf. It's a static weight-400 cut of the site's own Nunito variable font, with the same subset and OFL license; the image renderer only reads TTF. Its provenance is recorded in fonts/README.md.

These cards now differ from the shared design in monorepo/packages/og that the old code matched.

Test plan

  • Rendered the home, datafeed, Chart API and TradingView-migration cards through the docs dev server; they look as described above.
  • npm run docs:check passes.
  • Docs build in CI.

🤖 Generated with Claude Code

The docs' social cards drop the black canvas, per-page color rail, wordmark
header and 148px headlines for GitHub's repository-card layout: a white card
with `bloxwap/chart` (or the page title under a `bloxwap/chart · Guides`
line) and a grey description, the Bloxwap mark in the avatar slot, version,
license and dependency count read from packages/chart/package.json, and the
brand palette as the bottom language bar.

Descriptions use a regular weight, so fonts/ gains Nunito-Regular.ttf: a
static weight-400 instance of the site's own Nunito variable font (same
subset and OFL license), since the image renderer only reads TTF.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@joeblau
joeblau merged commit 53f3061 into main Sep 30, 2026
3 checks passed
@joeblau
joeblau deleted the style/github-style-og-cards branch September 30, 2026 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant