Skip to main content

🔧 Configuration

The plugin works with default settings out of the box. You can optionally override settings in your config/plugins.js (or config/plugins.ts) file.

The example below shows all available configuration options with their default values:

config/plugins.js
import deburr from 'lodash/deburr';
import toLower from 'lodash/toLower';
import kebabCase from 'lodash/kebabCase';

export default ({ env }) => ({
webtools: {
enabled: true,
config: {
default_pattern: "/[pluralName]/[documentId]",
website_url: null,
unique_per_locale: false,
slugify: (fieldValue) => kebabCase(deburr(toLower(fieldValue))),
},
},
});

Configuration options overview

OptionTypeDefaultDescription
default_patternstring/[pluralName]/[documentId]Fallback pattern when no specific pattern is set for a content type
website_urlstringnullBase URL for permalink generation in admin UI
slugifyfunctionkebabCase(deburr(toLower()))Transform field values into URL-safe slugs (converts "My Title" to "my-title")
unique_per_localebooleanfalseAllow same URL alias across different locales

URL bundle settings (sitemap)

When configuring sitemap URL bundles, each bundle supports:

SettingOptionsDescription
Change frequencyhourly, daily, weekly, monthly, yearlyHow often search engines should crawl these URLs
Priority0.1 - 1.0Relative importance of URLs in this bundle
Default language URL typeDisabled, Default language URL of bundles, OtherHow default locale appears in URLs
💡 Pattern tokens

Available tokens for URL patterns: [documentId], [locale], [pluralName], and any field from your content type. Type [ in the pattern field to see all available options.