astro-seo - npm Package Compare versions
Comparing version 0.2.1 to 0.3.1
| { | ||
| "name": "astro-seo", | ||
| "version": "0.2.1", | ||
| "version": "0.3.1", | ||
| "description": "Makes it easy to add SEO relevant tags to your Astro app.", | ||
@@ -5,0 +5,0 @@ "homepage": "https://github.com/jonasmerlin/astro-seo#readme", |
@@ -6,3 +6,3 @@  | ||
| This [Astro](https://astro.build/) component makes it easy to add tags that are | ||
| relevant for seach engine optimization (SEO) to your pages. | ||
| relevant for search engine optimization (SEO) to your pages. | ||
@@ -46,10 +46,40 @@ The ultimate goal is to make this the one-stop shop for most of your SEO needs when developing Astro sites. | ||
| noindex | boolean | Set this to true if you don't want search engines to index your page. Since this is an SEO component, this gets set to `false` by default. This way, indexing is strictly opt-out. | ||
| nofollow | boolean | Set this to true if you don't want search engines to follow links | ||
| on your page. Since this is an SEO component, this gets set to `false` by default. This way, following links is strictly opt-out. | ||
| openGraph.title | string | Set the title Open Graph should use. This can differ from your general page title. If you define this, you mus define the other 3 OG basic properties as well: `type`, `image` and `url`. ([Learn more.](https://ogp.me/#metadata)) | ||
| openGraph.type | string | Set the [type](https://ogp.me/#types) Open Graph should use. If you define this, you mus define the other 3 OG basic properties as well: `title`, `image` and `url`. ([Learn more.](https://ogp.me/#metadata)) | ||
| openGraph.image | string | URL of the image that should be used in social media previews. If you define this, you mus define the other 3 OG basic properties as well: `title`, `type` and `url`. ([Learn more.](https://ogp.me/#metadata)) | ||
| openGraph.url | string | The canonical URL of your object that will be used as its permanent ID in the graph. Mostl likely either the url of the page or its canonical url (see above). If you define this, you mus define the other 3 OG basic properties as well: `title`, `type` and `image`. ([Learn more.](https://ogp.me/#metadata)) | ||
| nofollow | boolean | Set this to true if you don't want search engines to follow links on your page. Since this is an SEO component, this gets set to `false` by default. This way, following links is strictly opt-out. | ||
| openGraph.basic.title | string | Set the title Open Graph should use. This can differ from your general page title. If you define this, you must define the other 3 OG basic properties as well: `type`, `image` and `url`. ([Learn more.](https://ogp.me/#metadata)) | ||
| openGraph.basic.type | string | Set the [type](https://ogp.me/#types) Open Graph should use. If you define this, you must define the other 3 OG basic properties as well: `title`, `image` and `url`. ([Learn more.](https://ogp.me/#metadata)) | ||
| openGraph.basic.image | string | URL of the image that should be used in social media previews. If you define this, you must define the other 3 OG basic properties as well: `title`, `type` and `url`. ([Learn more.](https://ogp.me/#metadata)) | ||
| openGraph.basic.url | string | The canonical URL of your object that will be used as its permanent ID in the graph. Mostl likely either the url of the page or its canonical url (see above). If you define this, you must define the other 3 OG basic properties as well: `title`, `type` and `image`. ([Learn more.](https://ogp.me/#metadata)) | ||
| openGraph.optional.audio | string | A URL to an audio file to accompany this object. | ||
| openGraph.optional.description | string | A one to two sentence description of your object. | ||
| openGraph.optional.determiner | string | The word that appears before this object's title in a sentence. An enum of (a, an, the, "", auto). If auto is chosen, the consumer of your data should chose between "a" or "an". Default is "" (blank). | ||
| openGraph.optional.locale | string | The locale these tags are marked up in. Of the format language_TERRITORY. Default is en_US. | ||
| openGraph.optional.localeAlternate | Array<string> | An array of other locales this page is available in. | ||
| openGraph.optional.siteName | string | If your object is part of a larger web site, the name which should be displayed for the overall site. e.g., "IMDb". | ||
| openGraph.optional.video | string | A URL to a video file that complements this object. | ||
| ## Open Graph | ||
| Open Graph properties are passed as one object to the prop `openGraph`. The structure of this object is modeled after the [Open Graph documentation](https://ogp.me/) itself. That means it uses nested objects to differentiate between basic and optional properties, as well as object specific ones. __If you pass an openGraph config, you _must_ define all 4 of the basic properties (`title`, `type`, `image` and `url`).__ The optional properties are all ... well, optional. | ||
| ```typescript | ||
| // TypeScript interface of openGraph prop | ||
| openGraph?: { | ||
| basic: { | ||
| title: string; | ||
| type: string; | ||
| image: string; | ||
| url: string; | ||
| }, | ||
| optional?: { | ||
| audio?: string; | ||
| description?: string; | ||
| determiner?: string; | ||
| locale?: string; | ||
| localeAlternate?: Array<string>; | ||
| siteName?: string; | ||
| video?: string; | ||
| } | ||
| } | ||
| ``` | ||
| ## Goals | ||
@@ -56,0 +86,0 @@ |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by44.29%
9197
- Number of lines in readme file
- increased by37.5%
110
No dependency changes