Install Nuxt Schema.org

Copy for LLMs

Last updated Nov 1, 2024 by

Harlan Wilton

in doc: misc improvements.

Module Setup

bash

npx nuxi module add schema-org

bash

npm i nuxt-schema-org

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-schema-org',
  ],
})

bash

yarn add nuxt-schema-org

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-schema-org',
  ],
})

bash

pnpm i nuxt-schema-org

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-schema-org',
  ],
})

bash

bun i nuxt-schema-org

You will need to manually add the module to your Nuxt config.

nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-schema-org',
  ],
})

SPA Warning

Due to the code required to generate Schema.org nodes, it is recommended to use SSR when using this module.

If you need Schema.org support in an SPA please use useHead({ script: [{ type: 'application/ld+json', innerHTML: '...' }] }) to add Schema.org nodes.

After you've set up the module, you should be able to visit your home page and inspect the Schema.org. You'll find the <script type="application/ld+json"> tag with the default Schema.org nodes near the </body> tag.

This is generated by the defaults Schema.org and you can modify the output if it's not what you need.

You can debug this further in Nuxt DevTools under the Schema.org tab.