Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harlan-zw merged 3 commits into from
Oct 6, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43726fa
docs: add the module icon to the README header
harlan-zw Oct 6, 2026
5048030
docs: put the module icon plate in the README heading
harlan-zw Oct 6, 2026
cfa1c9b
docs: unify the README badge row
harlan-zw Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/assets/icon.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 9 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
<img src=".github/assets/og-image-preview.png" alt="Nuxt OG Image DevTools Preview">

<h1>nuxt-og-image</h1>
<h1><a href="https://nuxtseo.com"><img src=".github/assets/icon.svg" width="40" height="40" alt="Nuxt SEO" align="top"></a> nuxt-og-image</h1>

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

<a href="https://skilld.dev/gh/nuxt-modules/og-image">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://skilld.dev/b/nuxt-modules/og-image?theme=dark">
<source media="(prefers-color-scheme: light)" srcset="https://skilld.dev/b/nuxt-modules/og-image?theme=light">
<img alt="Skill repository on skilld.dev" src="https://skilld.dev/b/nuxt-modules/og-image?theme=light">
</picture>
</a>
[![Skill repository on skilld.dev][skilld-src]][skilld-href]

Nuxt OG Image allows you to easily generate OG Images using either Vue components or screenshots of your pages.

Expand Down Expand Up @@ -78,14 +71,17 @@ npx nuxi@latest module add og-image
Licensed under the [MIT license](https://github.com/nuxt-modules/og-image/blob/main/LICENSE.md).

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/nuxt-og-image/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-src]: https://img.shields.io/npm/v/nuxt-og-image/latest.svg?style=flat&labelColor=16152b&color=00a63e
[npm-version-href]: https://npmjs.com/package/nuxt-og-image

[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-og-image.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-og-image.svg?style=flat&labelColor=16152b&color=00a63e
[npm-downloads-href]: https://npmjs.com/package/nuxt-og-image

[license-src]: https://img.shields.io/github/license/nuxt-modules/og-image.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-src]: https://img.shields.io/github/license/nuxt-modules/og-image.svg?style=flat&labelColor=16152b&color=00a63e
[license-href]: https://github.com/nuxt-modules/og-image/blob/main/LICENSE.md

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-src]: https://img.shields.io/badge/Nuxt-16152b?logo=nuxt&style=flat
[nuxt-href]: https://nuxt.com

[skilld-src]: https://skilld.dev/b/nuxt-modules/og-image?style=flat&labelColor=16152b&color=00a63e&logoColor=ffffff
[skilld-href]: https://skilld.dev/gh/nuxt-modules/og-image
Loading