svelte-meta-tags
Advanced tools
Comparing version 2.6.4 to 2.6.5
{ | ||
"name": "svelte-meta-tags", | ||
"version": "2.6.4", | ||
"version": "2.6.5", | ||
"description": "Svelte Meta Tags is a plugin that makes managing your SEO easier in Svelte projects.", | ||
@@ -24,21 +24,20 @@ "license": "MIT", | ||
"devDependencies": { | ||
"@playwright/test": "^1.28.0", | ||
"@sveltejs/adapter-auto": "^1.0.0-next.88", | ||
"@sveltejs/kit": "^1.0.0-next.551", | ||
"@sveltejs/package": "^1.0.0-next.6", | ||
"@typescript-eslint/eslint-plugin": "^5.43.0", | ||
"@typescript-eslint/parser": "^5.43.0", | ||
"eslint": "^8.27.0", | ||
"eslint-config-prettier": "^8.5.0", | ||
"@playwright/test": "^1.29.2", | ||
"@sveltejs/adapter-auto": "^1.0.2", | ||
"@sveltejs/kit": "^1.1.4", | ||
"@sveltejs/package": "^1.0.2", | ||
"@typescript-eslint/eslint-plugin": "^5.48.2", | ||
"@typescript-eslint/parser": "^5.48.2", | ||
"eslint": "^8.32.0", | ||
"eslint-config-prettier": "^8.6.0", | ||
"eslint-plugin-svelte3": "^4.0.0", | ||
"husky": "^8.0.2", | ||
"lint-staged": "^13.0.3", | ||
"prettier": "^2.7.1", | ||
"prettier-plugin-svelte": "^2.8.0", | ||
"svelte": "^3.53.1", | ||
"svelte-check": "^2.9.2", | ||
"svelte-preprocess": "^4.10.7", | ||
"husky": "^8.0.3", | ||
"lint-staged": "^13.1.0", | ||
"prettier": "^2.8.3", | ||
"prettier-plugin-svelte": "^2.9.0", | ||
"svelte": "^3.55.1", | ||
"svelte-check": "^3.0.2", | ||
"tslib": "^2.4.1", | ||
"typescript": "^4.9.3", | ||
"vite": "^3.2.4" | ||
"typescript": "^4.9.4", | ||
"vite": "^4.0.4" | ||
}, | ||
@@ -45,0 +44,0 @@ "peerDependencies": { |
144
README.md
@@ -8,3 +8,3 @@ <img src="./.github/logo.svg" alt="svelte-meta-tags" width="512" /> | ||
Svelte Meta Tags is a plugin that makes managing your SEO easier in Svelte projects. | ||
Svelte Meta Tags provides components designed to help you manage SEO for Svelte projects. | ||
@@ -128,50 +128,50 @@ [Demo](https://svelte.dev/repl/ffd783c9b8e54d97b6b7cac6eadace42) | ||
| Property | Type | Description | | ||
| ---------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `title` | string | Sets the page meta title. | | ||
| `titleTemplate` | string | Allows you to set default title template that will be added to your title [More Info](#title-template) | | ||
| `noindex` | boolean (default false) | Sets whether page should be indexed or not | | ||
| `nofollow` | boolean (default false) | Sets whether page should be followed or not | | ||
| `additionRobotsProps` | Object | Set the more meta information for the `X-Robots-Tag` [More Info](#robotsprops) | | ||
| `description` | string | Sets the page meta description. | | ||
| `canonical` | string | Set the page canonical url. | | ||
| `mobileAlternate.media` | string | Set what screen size the mobile website should be served from | | ||
| `mobileAlternate.href` | string | Set the mobile page alternate url | | ||
| `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. [More Info](#additional-meta-tags) | | ||
| `additionalLinkTags` | array | Allows you to add a link tag that is not documented here. [More Info](#additional-link-tags) | | ||
| `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.handle` | string | @username for the content creator / author (outputs as `twitter:creator`) | | ||
| `twitter.title` | string | The concise title for the related content | | ||
| `twitter.description` | string | The description that concisely summarizes the content as appropriate for presentation within a Tweet. You should not re-use 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 representing the content of the page. You should not use a generic image such as your website logo, author photo, or other image that spans multiple pages. Images for this Card support an aspect ratio of 1:1 with minimum dimensions of 144x144 or maximum 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 will be used. SVG is not supported | | ||
| `twitter.imageAlt` | string | The text description of the image conveying the essential nature of an image to users who are visually impaired. Maximum 420 characters. | | ||
| `facebook.appId` | string | Used for Facebook Insights, you must add a facebook app ID to your page to for it | | ||
| `openGraph.url` | string | The canonical URL of your object that 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 [More Info](#open-graph) | | ||
| `openGraph.title` | string | The open graph title, this can be different than your meta title. | | ||
| `openGraph.description` | string | The open graph description, this can be different than your meta description. | | ||
| `openGraph.images` | array | An array of images to be used as a preview. If multiple supplied you can choose one when sharing. [See Examples](#open-graph-examples) | | ||
| `openGraph.videos` | array | An array of videos (object) | | ||
| `openGraph.locale` | string | The locale the open graph tags are marked up in. | | ||
| `openGraph.site_name` | string | If your object is part of a larger web site, the name which should be displayed for the overall 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[] | Writers of the article. [See Examples](#open-graph-examples) | | ||
| `openGraph.book.isbn` | string | The [ISBN](https://en.wikipedia.org/wiki/International_Standard_Book_Number) | | ||
| `openGraph.book.releaseDate` | datetime | The date the book was released. | | ||
| `openGraph.book.tags` | string[] | Tag words associated with this book. | | ||
| `openGraph.article.publishedTime` | datetime | When the article was first published. [See Examples](#open-graph-examples) | | ||
| `openGraph.article.modifiedTime` | datetime | When the article was last changed. | | ||
| `openGraph.article.expirationTime` | datetime | When the article is out of date after. | | ||
| `openGraph.article.authors` | string[] | Writers 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. | | ||
| Property | Type | Description | | ||
| ---------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `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 [More Info](#title-template) | | ||
| `noindex` | boolean (default false) | Specifies whether the page should be indexed or not | | ||
| `nofollow` | boolean (default false) | Specifies whether or not to follow the page | | ||
| `additionRobotsProps` | Object | Set the additional meta information for the `X-Robots-Tag` [More Info](#robotsprops) | | ||
| `description` | string | Sets the meta description of the page | | ||
| `canonical` | string | Make the page canonical URL | | ||
| `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 [More Info](#additional-meta-tags) | | ||
| `additionalLinkTags` | array | Allows you to add a link tag that is not documented here [More Info](#additional-link-tags) | | ||
| `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.handle` | 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 [More Info](#open-graph) | | ||
| `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 [See Examples](#open-graph-examples) | | ||
| `openGraph.videos` | array | An array of videos (object) | | ||
| `openGraph.locale` | string | The locale in which the open graph tags are highlighted | | ||
| `openGraph.site_name` | 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 [See Examples](#open-graph-examples) | | ||
| `openGraph.book.isbn` | string | The [ISBN](https://en.wikipedia.org/wiki/International_Standard_Book_Number) | | ||
| `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 [See Examples](#open-graph-examples) | | ||
| `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 | | ||
#### Title Template | ||
Replaces `%s` with your title string | ||
Replace `%s` with your title string. | ||
@@ -204,3 +204,3 @@ ``` | ||
Check out the Twitter [documentation](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary) for more information. | ||
See out the Twitter [documentation](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary) for more information. | ||
@@ -215,7 +215,7 @@ #### Facebook | ||
Add this to your SEO config to include the fb:app_id meta if you need to enable Facebook insights for your site. Information regarding this can be found in facebook's [documentation](https://developers.facebook.com/docs/sharing/webmasters/) | ||
Add this to your SEO config to include the fb:app_id meta if you need to enable Facebook Insights for your site. Information on this can be found in Facebook's [documentation](https://developers.facebook.com/docs/sharing/webmasters/). | ||
#### robotsProps | ||
In addition to `index, follow` the `robots` meta tag accepts more properties to archive a more accurate crawling and serve better snippets for SEO bots that crawl your page. | ||
In addition to `index, follow', the `robots' meta tag accepts more properties to archive more accurate crawling and serve better snippets to SEO bots crawling your page. | ||
@@ -245,18 +245,18 @@ Example: | ||
| Property | Type | Description | | ||
| ------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `noarchive` | boolean | Do not show a [cached link](https://support.google.com/websearch/answer/1687222) in search results. | | ||
| `nosnippet` | boolean | Do not show a text snippet or video preview in the search results for this page. | | ||
| `maxSnippet` | number | Use a maximum of [number] characters as a textual snippet for this search result. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) | | ||
| `maxImagePreview` | 'none','standard','large' | Set the maximum size of an image preview for this page in a search results. | | ||
| `maxVideoPreview` | number | Use a maximum of [number] seconds as a video snippet for videos on this page in search results. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) | | ||
| `notranslate` | boolean | Do not offer translation of this page in search results. | | ||
| `noimageindex` | boolean | Do not index images on this page. | | ||
| `unavailableAfter` | string | Do not show this page in search results after the specified date/time. The date/time must be specified in a widely adopted format including, but not limited to RFC 822, RFC 850, and ISO 8601. | | ||
| Property | Type | Description | | ||
| ------------------ | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `noarchive` | boolean | Do not display a [cached link](https://support.google.com/websearch/answer/1687222) in search results | | ||
| `nosnippet` | boolean | Do not show a text snippet or video preview in the search results for this page | | ||
| `maxSnippet` | number | Use a maximum of [number] characters as the text snippet for this search result [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) | | ||
| `maxImagePreview` | 'none','standard','large' | Set the maximum size of an image preview for this page in a search result | | ||
| `maxVideoPreview` | number | Use a maximum of [number] seconds as a video snippet for videos on this page in search results [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) | | ||
| `notranslate` | boolean | Do not offer translation of this page in search results | | ||
| `noimageindex` | boolean | Do not index images on this page | | ||
| `unavailableAfter` | string | Do not show this page in search results after the specified date/time. The date/time must be in a widely accepted format, including but not limited to RFC 822, RFC 850, and ISO 8601 | | ||
For more reference about the `X-Robots-Tag` visit [Google Search Central - Control Crawling and Indexing](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) | ||
For more information on the `X-Robots-Tag` visit [Google Search Central - Control Crawling and Indexing](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) | ||
#### Alternate | ||
This link relation is used to indicate a relation between a desktop and a mobile website to search engines. | ||
This link relationship is used to indicate a relationship between a desktop and mobile website to search engines. | ||
@@ -283,5 +283,5 @@ Example: | ||
This allows you to add any other meta tags that are not covered in the `config`. | ||
This allows you to add any other meta tags that are not required by the `config`. | ||
`content` is required. Then either `name`, `property` or `httpEquiv`. (Only one on each) | ||
`content` is required. Then either `name`, `property` or `httpEquiv`. (only one of each) | ||
@@ -309,3 +309,3 @@ Example: | ||
These are invalid as they contain more than one of `name`, `property` and `httpEquiv` on the same entry. | ||
These are invalid because they contain more than one of `name`, `property`, and `httpEquiv` in the same entry. | ||
@@ -389,3 +389,3 @@ ```js | ||
For the full specification please check out <http://ogp.me/> | ||
The full specification can be found at <http://ogp.me/>. | ||
@@ -581,5 +581,5 @@ Svelte Meta Tags currently supports: | ||
JSON-LD allow for more customized and rich representation for example in search results. | ||
JSON-LD allows for more customized and richer display, such as in search results. | ||
To discover all the different content types JSON-LD offers check out: https://developers.google.com/search/docs/guides/search-gallery | ||
To discover all the different content types that JSON-LD offers, go to: https://developers.google.com/search/docs/guides/search-gallery | ||
@@ -590,10 +590,10 @@ It is also possible to use multiple `<JsonLd />` components in a single page. | ||
This plugin uses [schema-dts](https://github.com/google/schema-dts), so it also provides types other than the usage examples below. | ||
This plugin uses [schema-dts](https://github.com/google/schema-dts), so it provides other types than the examples below. | ||
### JSON-LD Properties | ||
| Property | Type | Description | | ||
| -------- | --------------------- | ---------------------------------------------------------------------------------------------------- | | ||
| `output` | string (default head) | Sets whether json-ld is output to `<head>` or `<body>`. Possible values are either `head` or `body`. | | ||
| `schema` | Object | Data in `ld+json` format. [See Examples](#json-ld-examples) | | ||
| Property | Type | Description | | ||
| -------- | --------------------- | -------------------------------------------------------------------------------------------------------- | | ||
| `output` | string (default head) | Specifies whether to output json-ld in `<head>` or `<body>`. Possible values are either `head` or `body` | | ||
| `schema` | Object | Data in `ld+json` format [See Examples](#json-ld-examples) | | ||
@@ -600,0 +600,0 @@ ### JSON-LD Examples |
73189
18