Community Templates · Nuxt OG Image · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

You're viewing **OG Image v5** documentation. For the latest, [switch to v6](https://nuxtseo.com/docs/og-image/getting-started/introduction).

[User Guides](https://nuxtseo.com/docs/og-image/v5/getting-started/introduction)

[API](https://nuxtseo.com/docs/og-image/v5/api/define-og-image)

[Releases](https://nuxtseo.com/docs/og-image/v5/releases/v5)

OG Image

- [Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v5

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Getting Started

- [Introduction](https://nuxtseo.com/docs/og-image/v5/getting-started/introduction)
- [Installation](https://nuxtseo.com/docs/og-image/v5/getting-started/installation)
- [Troubleshooting](https://nuxtseo.com/docs/og-image/v5/getting-started/troubleshooting)
- [Tutorial: Your first OG Image](https://nuxtseo.com/docs/og-image/v5/getting-started/getting-familar-with-nuxt-og-image)

### Core Concepts

- [Satori Renderer](https://nuxtseo.com/docs/og-image/v5/guides/satori)
- [Chromium Renderer](https://nuxtseo.com/docs/og-image/v5/guides/chromium)
- [Zero Runtime](https://nuxtseo.com/docs/og-image/v5/guides/zero-runtime)
- [Compatibility](https://nuxtseo.com/docs/og-image/v5/guides/compatibility)
- [Route Rules](https://nuxtseo.com/docs/og-image/v5/guides/route-rules)
- [Caching Images](https://nuxtseo.com/docs/og-image/v5/guides/cache)
- [JPEGs](https://nuxtseo.com/docs/og-image/v5/guides/jpegs)
- [Fonts](https://nuxtseo.com/docs/og-image/v5/guides/custom-fonts)
- [Non-English Locales](https://nuxtseo.com/docs/og-image/v5/guides/non-english-locales)
- [Emojis](https://nuxtseo.com/docs/og-image/v5/guides/emojis)
- [Icons and Images](https://nuxtseo.com/docs/og-image/v5/guides/icons-and-images)
- [Styling](https://nuxtseo.com/docs/og-image/v5/guides/styling)
- [Community Templates](https://nuxtseo.com/docs/og-image/v5/guides/community-templates)
- [Error pages](https://nuxtseo.com/docs/og-image/v5/guides/error-pages)

### Integrations

- [Nuxt Content](https://nuxtseo.com/docs/og-image/v5/integrations/content)
- [Nuxt Color Mode](https://nuxtseo.com/docs/og-image/v5/integrations/color-mode)

Core Concepts

# Community Templates

[Copy for LLMs](https://nuxtseo.com/docs/og-image/v5/guides/community-templates.md)

## [NuxtSeo](#nuxtseo)

![NuxtSeo Template](https://nuxtseo.com/og-image/community-template.png)

The `NuxtSeo` template is the default one provided for you. It comes with a number of props to let you customise it however you like.

Like all Community templates, it's recommended to copy+paste it into your project if you want to customise it. You can find the source on [GitHub](https://github.com/nuxt-modules/og-image/blob/main/src/runtime/app/components/Templates/Community/Nuxt.vue).

## [Props](#props)

### [`title`](#title)

**Type:** `string`**Default:** `<title>`

The title of the page. This will be used as the main heading.

### [`description`](#description)

**Type:** `string`**Default:** `<meta name="description" />`

The description of the page. This will be used as the subheading.

### [`icon`](#icon)

**Type:** `string` | `boolean`**Default:** `false`

The icon of the page. This will be used as the main image. Requires Nuxt Icon to be installed.

### [`siteName`](#sitename)

**Type:** `string`**Default:** Site Name from [Nuxt Site Config](https://nuxtseo.com/site-config/guides/setting-site-config)

Sets the bottom centered text of the template.

### [`siteLogo`](#sitelogo)

**Type:** `string`

Replaces the site name and the Nuxt Seo logo with a custom image.

See the [Icons and Images](https://nuxtseo.com/docs/og-image/guides/icons-and-images) guide for more information.

### [`theme`](#theme)

**Type:** `string`**Default:** `#00dc82`

Changes the theme of the template. You should either provide a hexadecimal color or a valid rgb.

For example: `#d946ef`

### [`colorMode`](#colormode)

**Type:** `light` | `dark`**Default:** `light`

Changes from a light or dark background / text color. Integrates with `@nuxtjs/color-mode`, selecting your default color mode.

[Edit this page](https://github.com/nuxt-modules/og-image/blob/v5.1.13/docs/content/3.guides/8.community-templates.md)

[Markdown For LLMs](https://nuxtseo.com/docs/og-image/v5/guides/community-templates.md)

Did this page help you?

[Styling How to style your OG Images.](https://nuxtseo.com/docs/og-image/v5/guides/styling) [Error pages How to display og images for error pages](https://nuxtseo.com/docs/og-image/v5/guides/error-pages)

On this page

- [NuxtSeo](#nuxtseo)
- [Props](#props)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

- [Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)
- [Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)
- [OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)
- [Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)
- [Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)
- [SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)
- [Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)
- [Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

### [NuxtSEO Pro](https://nuxtseo.com/pro "Home")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/docs/nuxt-seo-pro/mcp/installation)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Idea Generator](https://nuxtseo.com/tools/keyword-generator)
- [Keyword Research](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings](https://nuxtseo.com/tools/domain-rankings)

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)