docs

Schema Types

The plugin provides seven schema types you can use in your documents.

Type	Description	Use Case
`seoFields`	Complete SEO package	Main SEO fields for any document
`baseMeta`	Core meta fields grouped	Standalone title, description, image, keywords, canonical URL, and custom meta
`openGraph`	Open Graph meta tags	Social media sharing
`twitter`	X (Twitter) Card settings	X-specific optimization
`metaTag`	Custom meta attributes	Advanced meta tag management
`metaAttribute`	Individual meta attribute	Building custom meta tags
`robots`	Search engine directives	Control indexing and crawling

seoFields — Complete Package

The seoFields type includes everything: meta tags, Open Graph, X Cards, robots, keywords, images, and custom attributes. This is the recommended type for most documents.

Fields

titlestringMeta title — max 70 chars, warning at 60

descriptiontextMeta description — max 160 chars, warning at 150

canonicalUrlurlPreferred URL for duplicate content resolution

metaImageimageDefault social sharing image (1200×630px) — live feedback cross-checks OG & Twitter images

keywordsstring[]Array of editorial keywords

robotsobjectnoIndex and noFollow toggles

metaAttributesarrayCustom key/value meta tags

openGraphobjectOpen Graph title, desc, image, type, URL, site name

twitterobjectX Card type, title, desc, image, site, creator

baseMeta — Standalone Core Meta

The baseMeta type groups the core meta fields into a single reusable object — useful when you want title, description, image, keywords, and canonical URL without the full seoFields package. Pair it with openGraph and twitter for a custom composition.

Fields

titlestringMeta title — max 70 chars, warning at 60

descriptiontextMeta description — max 160 chars, warning at 150

metaImageimageDefault social sharing image (1200×630px)

keywordsstring[]Array of editorial keywords

canonicalUrlurlPreferred URL for duplicate content resolution

metaAttributesarrayCustom key/value meta tags

Open Graph Fields

titleOG title for social sharing

descriptionOG description text

urlCanonical URL for social cards

siteNamePublisher/site name

typewebsite, article, profile, book, music, video, product

imageTypeUpload or URL — controls which image field is used

imageUploaded image asset — live feedback checks alt text and cross-checks Meta/Twitter images

imageUrlExternal image URL — live feedback cross-checks Meta/Twitter images

X (Twitter) Card Fields

cardsummary, summary_large_image, app, player

sitePublisher X handle (e.g. @brand)

creatorAuthor X handle (e.g. @author)

titleCard title — max 70 chars

descriptionCard description — max 200 chars

imageTypeUpload or URL

imageUploaded image asset — live feedback checks alt text and cross-checks Meta/OG images

imageUrlExternal image URL — live feedback cross-checks Meta/OG images

Was this page helpful?