docs

Installation

Install the plugin with your preferred package manager.

npm

Package Managers

$npm install sanity-plugin-seofields

Requirements

Sanity Studiov3, v4 or v5

Reactv18 or v19

Register the Plugin

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

sanity.config.ts

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
    ],
  },
})

Note: The plugin works with zero configuration. The SEO Health Dashboard and live preview are enabled by default.

Required: License Key for Paid Features

To use paid features, add a valid root-level license key. $20 per Sanity project unlocks paid plugin features as a one-time purchase. Roadmap improvements are tracked on the roadmap. No subscription, ever.

Get your license key at the Get License page →

See Dashboard docs for setup instructions and configuration options.

Was this page helpful?