Skip to content

Latest commit

 

History

History
74 lines (65 loc) · 6.53 KB

gatsby-plugin-next-seo.md

File metadata and controls

74 lines (65 loc) · 6.53 KB

Home > gatsby-plugin-next-seo

gatsby-plugin-next-seo package

Interfaces

Interface Description
AllSeoProps
ArticleJsonLdProps The component props for a JSON LD Article.
BaseSeoProps
BlogJsonLdProps The Blog JSON LD props.
BlogPostJsonLdProps
BookJsonLdProps The Book JSON LD Component props.
BreadcrumbJsonLdProps
ContactPoint
CorporateContactJsonLdProps
CourseJsonLdProps The Course JSON LD Component props.
DefaultSeoProps
DeferSeoProps
FAQJsonLdProps The FAQPage JSON LD Component props.
GatsbySeoPluginOptions
GatsbySeoProps
ItemListElements
JsonLdProps
LocalBusinessJsonLdProps
LogoJsonLdProps The Logo JSON LD component properties.
NewsArticleJsonLdProps
OpenGraph
OpenGraphArticle
OpenGraphBook
OpenGraphImages
OpenGraphProfile
OpenGraphVideo
OpenGraphVideoActors
OpenGraphVideos
ProductJsonLdProps Component props for the Product JSON LD.
Question The questions and answers for an FAQ Page.
SitelinksSearchBoxJsonLdProps The Sitelinks search box JSON LD component properties.
SpeakableJsonLdProps The Speakable JSON LD Component props.
Twitter

Variables

Variable Description
ArticleJsonLd An article, such as a news article or piece of investigative report. Newspapers and magazines have articles of many different types and this is intended to cover them all.See also blog post.
BaseSeo This is the BaseSeo component which also takes in the default seo props.
BlogJsonLd
BlogPostJsonLd A utility component which wraps the <ArticleJsonLd /> component but is classified as a BlogPosting.
BookJsonLd The Book component makes search engines an entry point for discovering your books and authors. Users can then buy the books that they find directly from Search results.
BreadcrumbJsonLd A breadcrumb trail on a page indicates the page's position in the site hierarchy. A user can navigate all the way up in the site hierarchy, one level at a time, by starting from the last breadcrumb in the breadcrumb trail.
CorporateContactJsonLd
CourseJsonLd
FAQJsonLd A Frequently Asked Question (FAQ) page contains a list of questions and answers pertaining to a particular topic.
GatsbySeo This component render the tags in the <head> for SEO on a per page basis. As a bare minimum, you should add a title and description.
JsonLd Component that inline-includes a JSON-LD script where specified.
LocalBusinessJsonLd When users search for businesses on Google Search or Maps, Search results may display a prominent Knowledge Graph card with details about a business that matched the query.
LogoJsonLd Specify the image Google Search uses for your organization's logo in Search results and in the Knowledge Graph.
NewsArticleJsonLd A utility component which wraps the <ArticleJsonLd /> component but is classified as a NewsArticle.
ProductJsonLd Add markup to your product pages so Google can provide detailed product information in rich Search results — including Google Images.
SitelinksSearchBoxJsonLd The SitelinksSearchBoxJsonLd component can be used to add JSON-LD structured data to your website for a Sitelinks search box.
SpeakableJsonLd (BETA) The speakable schema.org property identifies sections within an article or webpage that are best suited for audio playback using text-to-speech (TTS).

Type Aliases

Type Alias Description
BookFormatType
LocalBusinessType
TwitterCardType