title | string | Sets the meta title of the page |
titleTemplate | string | Allows you to set the default title template that will be added to your title |
robots | string or boolean (default index,follow ) | Sets the meta robots of the page ⚠ You can disable it completely by setting it to false, but use it with caution as there is a risk that the page will not be indexed⚠ |
additionRobotsProps | Object | Set the additional meta information for the X-Robots-Tag |
description | string | Sets the meta description of the page |
canonical | string | Make the page canonical URL |
keywords | array | Sets the meta keywords of the page |
mobileAlternate.media | string | Set the screen size from which the mobile site will be served |
mobileAlternate.href | string | Set the alternate URL for the mobile page |
languageAlternates | array | Set the language of the alternate urls. Expects array of objects with the shape:{ hrefLang: string, href: string } |
additionalMetaTags | array | Allows you to add a meta tag that is not documented here |
additionalLinkTags | array | Allows you to add a link tag that is not documented here |
twitter.cardType | string | The card type, which will be one of summary , summary_large_image , app , or player |
twitter.site | string | @username for the website used in the card footer |
twitter.creator | string | @username for the creator of the content (output as twitter:creator ) |
twitter.title | string | The concise title for the related content |
twitter.description | string | The description that concisely summarizes the content in a manner suitable for presentation within a Tweet. You should not reuse the title as the description or use this field to describe the general services provided by the website |
twitter.image | string | The URL to a unique image that represents the content of the page. You should not use a generic image such as your site logo, author photo, or other image that spans multiple pages. Images for this card support a 1:1 aspect ratio with a minimum size of 144x144 pixels or a maximum size of 4096x4096 pixels. Images must be less than 5MB in size. The image will be cropped to a square on all platforms. JPG, PNG, WEBP, and GIF formats are supported. Only the first frame of an animated GIF is used. SVG is not supported |
twitter.imageAlt | string | The textual description of the image that conveys the essence of the image to visually impaired users. Maximum 420 characters |
facebook.appId | string | For Facebook Insights, you will need to add a Facebook app ID to your page in order to use it |
openGraph.url | string | The canonical URL of your object, which will be used as its permanent ID in the graph |
openGraph.type | string | The type of your object. Depending on the type you specify, other properties may also be required |
openGraph.title | string | The open graph title, this can be different from your meta title |
openGraph.description | string | The open graph description, which may be different from your meta description |
openGraph.images | array | An array of images to use as previews. If multiple are provided, you can choose one when sharing |
openGraph.videos | array | An array of videos (object) |
openGraph.audio | array | An array of audio(object) |
openGraph.locale | string | The locale in which the open graph tags are highlighted |
openGraph.siteName | string | If your item is part of a larger website, the name that should be displayed for the entire site |
openGraph.profile.firstName | string | Person’s first name |
openGraph.profile.lastName | string | Person’s last name |
openGraph.profile.username | string | Person’s username |
openGraph.profile.gender | string | Person’s gender |
openGraph.book.authors | string[] | Author of the article |
openGraph.book.isbn | string | The ISBN |
openGraph.book.releaseDate | datetime | The date the book was released |
openGraph.book.tags | string[] | Tag words related to this book |
openGraph.article.publishedTime | datetime | When the article was first published |
openGraph.article.modifiedTime | datetime | When the item was last modified |
openGraph.article.expirationTime | datetime | When the article is out of date after |
openGraph.article.authors | string[] | Author of the article |
openGraph.article.section | string | A high-level section name. E.g. Technology |
openGraph.article.tags | string[] | Tag words associated with this article |