Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
boazpoolman committed Mar 13, 2024
1 parent 2d51691 commit 9fe3b09
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,12 @@ This setting will add a default `/` entry to the sitemap XML when none is presen

> `required:` NO | `type:` bool | `default:` true
###### Key: `defaultLanguageUrlType`
### Default language URL (x-default)

This setting will add an additionnal `<link />` tag into each sitemap urls bundles with value `hreflang="x-default"` and the path of your choice. The hreflang x-default value is used to specify the language and region neutral URL for a piece of content when the site doesn't support the user's language and region. For example, if a page has hreflang annotations for English and Spanish versions of a page along with an x-default value pointing to the English version, French speaking users are sent to the English version of the page due to the x-default annotation. The x-default page can be a language and country selector page, the page where you redirect users when you have no content for their region, or just the version of the content that you consider default.

###### Key: `defaultLanguageUrlType`

> `required:` NO | `type:` string | `default:` ''
## 🔧 Config
Expand Down

0 comments on commit 9fe3b09

Please sign in to comment.