Skip to content

docs: add the module icon and unify the README badges - #721

Merged
harlan-zw merged 3 commits into
mainfrom
docs/brand-icon
Oct 6, 2026
Merged

harlan-zw merged 3 commits into
mainfrom
docs/brand-icon

Conversation

@harlan-zw

@harlan-zw harlan-zw commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

🔗 Linked issue

Related to harlan-zw/nuxt-seo#647

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

The Nuxt SEO brand refresh gives each module a hand-drawn icon. The README heading now opens with the OG Image icon and links it to nuxtseo.com.

The icon sits on the dark favicon plate inside the H1, so one SVG in .github/assets/ reads on GitHub's light and dark themes. A <picture> swap follows the OS colour scheme rather than GitHub's theme, so it showed dark ink on a dark page. The scripts/brand-assets.ts generator in harlan-zw/nuxt-seo#647 wrote the file.

The badge row now shows the same five badges in the brand ink and green, with the skilld badge inline as a Markdown badge. The skilld badge picks up the matching flat style and colours once skilld-dev/skilld.dev#458 deploys.

🤖 AI disclosure: Harlan Agent Kit modified this description. My AI open-source policy.

The Nuxt SEO brand refresh gives each module a hand-drawn icon.
The header shows it above the module name. Light and dark cuts
match the reader's GitHub theme.
@harlan-zw harlan-zw added harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review harlan-agent-review Approve automated work for the current issue state or pull request head commit. labels Oct 6, 2026
@pkg-pr-new

pkg-pr-new Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/nuxt-og-image@721

commit: cfa1c9b

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

📦 Package Size

✅ No notable size changes

All tracked output (19)
Package output Gzipped Raw
nuxt-og-image · dependency @clack/prompts 12 kB 51 kB ✅
nuxt-og-image · dependency @vue/compiler-sfc 578 kB 2.63 MB ✅
nuxt-og-image · dependency chrome-launcher 21 kB 69 kB ✅
nuxt-og-image · dependency devalue 21 kB 63 kB ✅
nuxt-og-image · dependency lightningcss 1.4 kB 3.6 kB ✅
nuxt-og-image · dependency magicast 72 kB 355 kB ✅
nuxt-og-image · dependency mocked-exports 1.3 kB 2.6 kB ✅
nuxt-og-image · dependency nuxt-site-config 10 kB 25 kB ✅
nuxt-og-image · dependency nuxtseo-shared 23 kB 78 kB ✅
nuxt-og-image · dependency oxc-parser 132 kB 1.38 MB ✅
nuxt-og-image · dependency radix3 4.3 kB 16 kB ✅
nuxt-og-image · dependency strip-literal 711 B 2.3 kB ✅
nuxt-og-image · dependency tinyexec 4.1 kB 13 kB ✅
nuxt-og-image · export . 364 B 886 B ✅
nuxt-og-image · export ./content 324 B 607 B ✅
nuxt-og-image · published payload 174 kB 600 kB ✅
nuxt-og-image · app runtime 9.2 kB 28 kB ✅
nuxt-og-image · server runtime 67 kB 184 kB ✅
nuxt-og-image · shared runtime 3.4 kB 10 kB ✅
Runtime dependencies (30)
Package Dependency Requested Resolved Cost
nuxt-og-image @clack/prompts ^1.8.1 1.8.1 📦 12 kB gzip
nuxt-og-image @nuxt/kit ^4.5.2 4.5.2 ♻️ free via Nuxt 4.5.2
nuxt-og-image @vue/compiler-sfc ^3.5.43 3.5.43 📦 578 kB gzip
nuxt-og-image chrome-launcher ^1.2.1 1.2.1 📦 21 kB gzip
nuxt-og-image consola ^3.4.2 3.4.2 ♻️ free via Nuxt 4.5.2
nuxt-og-image defu ^6.1.7 6.1.7 ♻️ free via Nuxt 4.5.2
nuxt-og-image devalue ^6.0.2 6.0.2 📦 21 kB gzip, Nuxt has 5.9.2
nuxt-og-image exsolve ^1.1.1 1.1.1 ♻️ free via Nuxt 4.5.2
nuxt-og-image fnv1a-64 ^0.1.2 0.1.2 ♻️ free via Nuxt 4.5.2
nuxt-og-image lightningcss ^1.33.0 1.33.0 📦 1.4 kB gzip
nuxt-og-image magic-string ^1.4.2 1.4.2 ♻️ free via Nuxt 4.5.2
nuxt-og-image magicast ^0.5.5 0.5.5 📦 72 kB gzip
nuxt-og-image mocked-exports ^0.1.1 0.1.1 📦 1.3 kB gzip
nuxt-og-image nuxt-site-config ^4.2.3 4.2.3 📦 10 kB gzip
nuxt-og-image nuxtseo-shared ^5.3.16 5.3.16 📦 23 kB gzip
nuxt-og-image nypm ^0.6.10 0.6.10 ♻️ free via Nuxt 4.5.2
nuxt-og-image object-identity ^0.2.3 0.2.3 ♻️ free via Nuxt 4.5.2
nuxt-og-image ofetch ^1.5.1 1.5.1 ♻️ free via Nuxt 4.5.2
nuxt-og-image ohash ^2.0.12 2.0.12 ♻️ free via Nuxt 4.5.2
nuxt-og-image oxc-parser ^0.151.0 0.151.0 📦 132 kB gzip
nuxt-og-image oxc-walker ^1.1.1 1.1.1 ♻️ free via Nuxt 4.5.2
nuxt-og-image pathe ^2.0.3 2.0.3 ♻️ free via Nuxt 4.5.2
nuxt-og-image pkg-types ^2.3.3 2.3.3 ♻️ free via Nuxt 4.5.2
nuxt-og-image radix3 ^1.1.2 1.1.2 📦 4.3 kB gzip
nuxt-og-image std-env ^4.2.0 4.2.0 ♻️ free via Nuxt 4.5.2
nuxt-og-image strip-literal ^4.0.0 4.0.0 📦 711 B gzip
nuxt-og-image tinyexec ^1.3.1 1.3.1 📦 4.1 kB gzip
nuxt-og-image ufo ^1.6.4 1.6.4 ♻️ free via Nuxt 4.5.2
nuxt-og-image ultrahtml ^1.7.0 1.7.0 ♻️ free via Nuxt 4.5.2
nuxt-og-image unplugin ^3.4.0 3.4.0 ♻️ free via Nuxt 4.5.2

Baseline: main_@_cdb0dc20___2026-10-03 · gzip is the comparison metric · changes below 16 B gzip are ignored

@harlan-zw harlan-zw added harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. harlan-agent-running An Agent holds a Task on this issue or pull request right now. and removed harlan-agent-review Approve automated work for the current issue state or pull request head commit. labels Oct 6, 2026
@harlan-zw

harlan-zw commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator Author

🤖 MERGED

Harlan Agent Kit posted this automated review. It is not Harlan's personal review or approval. AI open source policy. Last updated: 2026-10-06 08:51 UTC.

GitHub merged this pull request.

  • Logged (10/100): Until the skilld.dev endpoint ships the params, the badge renders in default stone/dark style, 22px vs 20px, visually inconsistent with the rest of the badge row. View code
    • Ask an agent to verify and fix this finding

ff2d13a9-8ae9-4f48-bd7d-63c3e270490d

Selected findings run after merge and open separate pull requests.

@harlan-zw harlan-zw added harlan-agent-ready The automated Review passed every gate on this head commit. and removed harlan-agent-running An Agent holds a Task on this issue or pull request right now. harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review labels Oct 6, 2026
GitHub swaps <picture> sources by the OS colour scheme, not by its own theme, so the dark-ink icon showed on GitHub's dark theme. The icon now sits on the dark favicon plate inside the H1. One SVG reads on both themes.
@harlan-zw harlan-zw added harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review harlan-agent-review Approve automated work for the current issue state or pull request head commit. harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. and removed harlan-agent-review Approve automated work for the current issue state or pull request head commit. labels Oct 6, 2026
Every Nuxt SEO README now shows the same five badges in the brand's ink and green. The skilld badge becomes a Markdown badge in the row, so it no longer drops to its own line.
@harlan-zw harlan-zw added harlan-agent-review Approve automated work for the current issue state or pull request head commit. harlan-agent-running An Agent holds a Task on this issue or pull request right now. harlan-agent-ready The automated Review passed every gate on this head commit. and removed harlan-agent-review Approve automated work for the current issue state or pull request head commit. harlan-agent-ready The automated Review passed every gate on this head commit. harlan-agent-running An Agent holds a Task on this issue or pull request right now. harlan-agent-review-required Pull request triage requires an adversarial Review for this head commit. labels Oct 6, 2026
@harlan-zw harlan-zw changed the title docs: add the module icon to the README header docs: add the module icon and unify the README badges Oct 6, 2026
@harlan-zw
harlan-zw merged commit b6b8d8d into main Oct 6, 2026
6 checks passed
@harlan-zw harlan-zw removed the harlan-agent-ready The automated Review passed every gate on this head commit. label Oct 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

harlan-agent-auto-merge Lets harlan-github-agent merge this after a READY review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant