@hyas/seo - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

CHANGELOG.md

@@ -7,5 +7,12 @@ ### Changelog
 
-#### [v2.0.0](https://github.com/gethyas/seo/compare/v1.0.4...v2.0.0)
+#### [v2.1.0](https://github.com/gethyas/seo/compare/v2.0.0...v2.1.0)
 
+- feat: add schemas for rich results [`c7b94e8`](https://github.com/gethyas/seo/commit/c7b94e8865aa029686fd99fd32351badb06067ae)
+
+### [v2.0.0](https://github.com/gethyas/seo/compare/v1.0.4...v2.0.0)
+
+> 13 October 2023
+
 - feat: update partials [`e0545b7`](https://github.com/gethyas/seo/commit/e0545b7e9937517bbb4a367009b33f6dc0911b9a)
+- meta: update CHANGELOG.md [`bf81b82`](https://github.com/gethyas/seo/commit/bf81b82af1ff700406227948e46b4aebedc2303f)
 
@@ -12,0 +19,0 @@ #### [v1.0.4](https://github.com/gethyas/seo/compare/v1.0.3...v1.0.4)

package.json

 {
   "name": "@hyas/seo",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Hyas SEO",
@@ -5,0 +5,0 @@ "author": "Hyas",

README.md

@@ -43,3 +43,3 @@ # Hyas SEO
 # Hugo
-title = "My Docs"
+title = "Hyas"
 description = "Congrats on setting up a new Doks project!"
@@ -56,7 +56,32 @@ images = ["cover.png"]
     icon = "favicon.png" # favicon.png (default)
-    svg_icon = "favicon.svg" # favicon.svg (default)
-    mask_icon = "mask-icon.svg" # mask-icon.svg (default)
-    mask_icon_color = "white" # white (default)
+    svgIcon = "favicon.svg" # favicon.svg (default)
+    maskIcon = "mask-icon.svg" # mask-icon.svg (default)
+    maskIconColor = "white" # white (default)
+  [seo.schemas]
+    type = "Organization" # Organization (default) or Person
+    logo = "images/favicon.png" # Logo of Organization — images/favicon.png (default)
+    name = "Hyas" # Name of Organization or Person
+    sameAs = [] # E.g. ["https://github.com/gethyas/hyas", "https://fosstodon.org/@hyas"]
+    images = ["images/cover.png"] # ["images/cover.png"] (default)
+    article = [] # Article sections
+    newsArticle = [] # NewsArticle sections
+    blogPosting = ["blog"] # BlogPosting sections
+    product = [] # Product sections
 ```
 
+Set parameters in page frontmatter:
+
+```yml
+seo:
+  title: "" # custom title (optional)
+  description: "" # custom description (recommended)
+  canonical: "" # custom canonical URL (optional)
+  noindex: false # false (default) or true
+  structured_data:
+    product:
+      currency: USD
+      price: 500
+      availability: https://schema.org/OnlineOnly
+```
+
 ## How to use
@@ -73,1 +98,3 @@
 - [Hugo SEO](https://gitlab.com/hugo-modules/hugo-seo)
+- [Structured Data for Breadcrumbs](https://bullaki.com/projects/web-design/seo-with-hugo-5-breadcrumbs/)
+- [Schema.org pieces](https://developer.yoast.com/features/schema/pieces/)

New alerts

License Policy Violation

License

This 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

License

This 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

27446

increased by92.32%

Number of package files

31

increased by40.91%

Number of lines in readme file

98

increased by38.03%

No dependency changes