NuxtSEO
Core Concepts

Setting up your site identity connects your Schema.org to Google's Knowledge Graph, enabling your logo and social links to appear in search results.

Providing an identity links Default Schema.org to your site author. Organization or LocalBusiness nodes can trigger Rich Results.

Which identity type should I use?

Choose based on your site type:

When should I use Person?

Use Person when your website is about a person, personal brand, or personal blog.

Example: harlanzw.com, antfu.me

import { definePerson } from 'nuxt-schema-org/schema'

export default defineNuxtConfig({
  schemaOrg: {
    identity: definePerson({
      name: 'Harlan Wilton',

      // Profile Information, if applicable
      image: '/profile-photo.jpg',
      description: 'Software engineer and open-source contributor',

      url: 'harlanzw.com',
      sameAs: [
        'https://twitter.com/harlan_zw',
        'https://github.com/harlan-zw'
      ],
    })
  }
})

When should I use Organization?

Use Organization for companies, brands, non-profits, or communities. Also use it as a fallback when other options don't fit.

import { defineOrganization } from 'nuxt-schema-org/schema'

export default defineNuxtConfig({
  schemaOrg: {
    identity: defineOrganization({
      // Basic Information
      name: 'TechCorp Solutions',
      logo: '/logo.png',
    })
  }
})

When should I use LocalBusiness?

Use LocalBusiness for local businesses, stores, restaurants, or services with a physical address.

Some examples of LocalBusiness{lang="ts}: : Restaurant, HealthAndBeautyBusiness, ProfessionalService, FinancialService, MedicalBusiness, etc...

Google recommends using the most specific type of LocalBusiness that fits your business, check the list of subtypes to find the most appropriate.

If you need to use dynamic data, you can use the defineLocalBusiness function to define the identity within your app.vue.

import { defineLocalBusiness } from 'nuxt-schema-org/schema'

export default defineNuxtConfig({
  schemaOrg: {
    identity: defineLocalBusiness({
      '@type': '...', // Choose from https://schema.org/LocalBusiness#subtypes

      // Basic Information (Required)
      'name': 'The Coastal Kitchen',
      'description': 'Farm-to-table restaurant specializing in sustainable seafood and seasonal ingredients',
      'url': 'https://thecoastalkitchen.com',

      // Location (Required)
      'address': {
        streetAddress: '742 Oceanview Boulevard, Suite 100',
        addressLocality: 'Santa Cruz',
        addressRegion: 'CA',
        postalCode: '95060',
        addressCountry: 'US'
      },
    }),
  }
})

When should I use OnlineStore?

Use OnlineStore for ecommerce sites selling products online.

import { defineOrganization } from 'nuxt-schema-org/schema'

export default defineNuxtConfig({
  schemaOrg: {
    identity: defineOrganization({
      '@type': ['Organization', 'Store', 'OnlineStore'],

      // Basic Information
      'name': 'ModernHome',
      'logo': '/logo.png',
    }),
  }
})
Verify your identity - Check your Organization or Person schema is correct with our Schema.org Validator.

Recipes

It's recommended to provide as much information about your identity as possible, here are some recipes.

Social Media Profiles

Edit this page
Markdown For LLMs
Did this page help you?

Default Schema.org

The default Schema.org setup for Nuxt Schema.org.

Nuxt I18n

How to use the Nuxt Schema.org module with Nuxt I18n.