fix: Disable seo by default

BREAKING CHANGE: Global seo option is now disabled by default. To preserve the previous behaviour, set `seo: true` in the module's options. Doc: https://nuxt-community.github.io/nuxt-i18n/seo.html fixes #346
nuxt-modules · Jul 20, 2019 · 741ae12 · 741ae12
1 parent ecc1714
commit 741ae12
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 10 deletions.
diff --git a/docs/options-reference.md b/docs/options-reference.md
@@ -78,9 +78,11 @@ Here are all the options available when configuring the module and their default
   // HTTP header instead of window.location
   forwardedHost: false,
 
-  // If true, SEO metadata is generated for routes that have i18n enabled
-  // Set to false to disable app-wide
-  seo: true,
+  // If true, SEO metadata is generated for routes that have i18n enabled.
+  // Note that performance can suffer with this enabled and there might be compatibility
+  // issues with some plugins. Recommended way is to set up SEO as described in:
+  // https://nuxt-community.github.io/nuxt-i18n/seo.html#improving-performance
+  seo: false,
 
   // Base URL to use as prefix for alternate URLs in hreflang tags
   baseUrl: '',

diff --git a/docs/seo.md b/docs/seo.md
@@ -1,11 +1,11 @@
 # SEO
 
-By default, **nuxt-i18n** attempts to add some metadata to improve your pages SEO. Here's what it does:
+With `seo` option enabled, **nuxt-i18n** attempts to add some metadata to improve your pages SEO. Here's what it does:
 
 * Add a _lang_ attribute containing current locale's ISO code to the `<html>` tag.
 * Generate `<link rel="alternate" hreflang="x">` tags for every language configured in `nuxt.config.js`. For each language, the ISO code is used as `hreflang` attribute's value. [More on hreflang](https://support.google.com/webmasters/answer/189077)
 * Generate `og:locale` and `og:locale:alternate` meta tags as defined in the [Open Graph protocol](http://ogp.me/#optional)
-* When using `prefix_and_default` strategy, generate `rel="canonical"` link on the default language routes containing the 
+* When using `prefix_and_default` strategy, generate `rel="canonical"` link on the default language routes containing the
 prefix to avoid duplicate indexation. [More on canonical](https://support.google.com/webmasters/answer/182192#dup-content)
 
 
@@ -43,13 +43,13 @@ You should also set the `baseUrl` option to your production domain in order to m
 ```
 
 
-To disable this feature everywhere in your app, set `seo` option to `false`:
+To enable this feature everywhere in your app, set `seo` option to `true`:
 
 ```js
 // nuxt.config.js
 
 ['nuxt-i18n', {
-  seo: false
+  seo: true
 }]
 ```
 
@@ -76,7 +76,7 @@ This means each time a component is created, the SEO metadata is recomputed for
 To improve performance you can use the `$nuxtI18nSeo` method in your layout instead.
 It will generate i18n SEO metadata for the current context.
 
-First you need to disable automatic SEO by setting `seo` to `false` in your configuration:
+First make sure automatic SEO is disabled by setting `seo` to `false` in your configuration or removing that option completely:
 
 ```js
 // nuxt.config.js

diff --git a/src/helpers/constants.js b/src/helpers/constants.js
@@ -40,7 +40,7 @@ exports.DEFAULT_OPTIONS = {
   },
   differentDomains: false,
   forwardedHost: false,
-  seo: true,
+  seo: false,
   baseUrl: '',
   vuex: {
     moduleName: 'i18n',

diff --git a/types/vue.d.ts b/types/vue.d.ts
@@ -61,7 +61,7 @@ declare namespace NuxtVueI18n {
       langDir: string | null
       rootRedirect: string | null
       detectBrowserLanguage: Options.DetectBrowserLanguageInterface
-      seo: false
+      seo: boolean
       baseUrl: string
       vuex: Options.Vuex
       parsePages: boolean