Installation

npm

Register the Plugin

Add the plugin to your sanity.config.ts (or .js) file:

import { defineConfig } from 'sanity'
import seofields from 'sanity-plugin-seofields'

export default defineConfig({
  name: 'your-project',
  title: 'Your Project',
  projectId: 'your-project-id',
  dataset: 'production',
  plugins: [
    seofields(),  // Add the SEO fields plugin
    // ... other plugins
  ],
  schema: {
    types: [
      // ... your schema types
    ],
  },
})

Verify the installation

1. Add a field of type seoFields to a document type, for example defineField({ name: 'seo', type: 'seoFields' }).
2. Start Studio with npx sanity dev, open a document of that type and expand the SEO field. You should see title, description, Open Graph and X fields, the SERP preview and character counters.
3. Run npx seofields doctor. It checks locally that your Studio config exists, the plugin is registered and the sanity and react peer dependencies are installed.

Troubleshooting

• ERESOLVE peer dependency error on Studio 6: upgrade to sanity-plugin-seofields@1.11.0 or later, which widened the supported Studio range to include v6.
• Missing icon export errors: use version 1.11.0 or later. It works with the @sanity/icons versions that Studio 3 to 6 ship.
• Nothing appears in the document: confirm the field type is seoFields (case-sensitive) and that seofields() is in the plugins array.

Installation FAQ