Skip to content

Commit f09cb05

Browse files
committed
docs(guide): update canonicalQueryWhitelist description for clarity
1 parent 1042fd3 commit f09cb05

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/guide/getting-started.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -498,19 +498,20 @@ Specifies whether, when using the **no prefix** strategy, a redirect should auto
498498

499499
### 🔄 `canonicalQueryWhitelist`
500500

501-
Specifies which query parameters should be preserved in the canonical URL.
502-
This helps search engines differentiate between content-modifying queries (e.g., `?page=2`) and tracking or irrelevant parameters (e.g., `?utm_source=`), which are excluded by default.
501+
Specifies which query parameters should be preserved in the canonical URL and the `og:url` meta tag.
502+
This helps search engines and social platforms differentiate between meaningful parameters (e.g., `?page=2`) and irrelevant or tracking ones (e.g., `?utm_source=`), which are excluded by default.
503503

504504
**Type**: `string[]`
505505
**Default**: `['page', 'sort', 'filter', 'search', 'q', 'query', 'tag']`
506506

507+
Both `<link rel="canonical">` and `<meta property="og:url">` will include only the whitelisted query parameters.
508+
507509
**Example**:
508510

509511
```ts
510-
canonicalQueryWhitelist: ['page', 'sort', 'category'] // Only include these query params in <link rel="canonical">
512+
canonicalQueryWhitelist: ['page', 'sort', 'category'] // Only include these query params in canonical and og:url
511513
```
512514

513-
514515
### 🌐 `globalLocaleRoutes`
515516

516517
Allows you to define custom localized routes for specific pages. You can specify a custom path for each locale for a given page, or disable localization for certain pages entirely.

0 commit comments

Comments
 (0)