Saltearse al contenido

Mapa del Sitio XML y Hreflang — Guía de Desarrollo y Admin UI

Ventana de terminal
pnpm add @vicacha-devs/strapi-plugin-sitemap

2. Configuración del Servidor (config/plugins.ts)

Sección titulada «2. Configuración del Servidor (config/plugins.ts)»

Agregue la configuración del plugin en el archivo config/plugins.ts de su aplicación Strapi v5:

config/plugins.ts
export default ({ env }: { env: (key: string, defaultValue?: string) => string }) => ({
"sitemap": {
enabled: true,
config: {
hostname: env("SITEMAP_HOSTNAME", "https://example.org"),
includeHreflang: true,
},
},
});

Mapa del Sitio XML y Hreflang — Strapi v5 Settings Panel

3. Recorrido por la Interfaz de Administración (Strapi v5 Admin UI)

Sección titulada «3. Recorrido por la Interfaz de Administración (Strapi v5 Admin UI)»

Una vez habilitado, el plugin registra su espacio de trabajo y ajustes dentro del panel de administración de Strapi v5 utilizando Strapi Design System v2:

Mapa del Sitio XML y Hreflang — Strapi v5 Admin UI

Etiquetas Localizadas de la Interfaz (Español)

Sección titulada «Etiquetas Localizadas de la Interfaz (Español)»
Clave de Traducción Texto en Interfaz
plugin.name Mapa del sitio
plugin.section.item Configuración
settings.title Mapa del sitio (Sitemap)
settings.subtitle Configuración del archivo XML de mapa del sitio e índice de sitemaps
settings.showSitemap Ver Sitemap
settings.baseUrl.title URL Base
settings.baseUrl.description Ingrese la URL base utilizada para todas las entradas del mapa del sitio
settings.baseUrl.placeholder https://ejemplo.com

4. Entidades Content-Type, Ubicación y Esquemas (strapi.documents)

Sección titulada «4. Entidades Content-Type, Ubicación y Esquemas (strapi.documents)»

Registers two internal Collection Types (plugin::sitemap.sitemap-content-type and plugin::sitemap.sitemap-content-type-single-url) and one Single Type (plugin::sitemap.sitemap-option) with content-manager.visible: false, while introspecting all public api::* and plugin::* Content-Type entities to generate /api/sitemap/sitemap.xml and /api/sitemap/sitemap-{slug}.xml.

Dónde Encontrar las Entidades Content-Type en Strapi v5

Sección titulada «Dónde Encontrar las Entidades Content-Type en Strapi v5»
  • Settings Panel (4 Tabs): /admin/settings/sitemap (Settings -> Sitemap -> Configuration — organized into General & Sitemap Index, Collection Types, Custom URLs, and Excluded URLs tabs)
  • Internal Persistence Entities: plugin::sitemap.sitemap-content-type (strapi_5_sitemap_plugin_content_types), plugin::sitemap.sitemap-content-type-single-url (strapi_5_sitemap_plugin_content_type_single_urls), and plugin::sitemap.sitemap-option (strapi_5_sitemap_plugin_options)

plugin::sitemap.sitemap-content-type — Sitemap Content Type

Sección titulada «plugin::sitemap.sitemap-content-type — Sitemap Content Type»

Per-locale URL pattern, priority, and changefreq mapping for a Strapi Content-Type entity

Kind: collectionType · DB Table: strapi_5_sitemap_plugin_content_types · Admin Location: Internal (/admin/plugins/sitemap) · Draft & Publish: No · i18n: No

Atributo Tipo en Strapi Requerido Restricciones / Relación
type string No —
langcode string No —
pattern string No —
priority float No —
frequency string No —
lastModified string No —
thumbnail string No —
populateLinkedModels string No —

plugin::sitemap.sitemap-content-type-single-url — Sitemap Single URL

Sección titulada «plugin::sitemap.sitemap-content-type-single-url — Sitemap Single URL»

Custom static URL entry included alongside dynamic CMS entries in sitemap.xml

Kind: collectionType · DB Table: strapi_5_sitemap_plugin_content_type_single_urls · Admin Location: Internal (/admin/plugins/sitemap) · Draft & Publish: No · i18n: No

Atributo Tipo en Strapi Requerido Restricciones / Relación
slug string No —
priority float No —
frequency string No —

plugin::sitemap.sitemap-option — Sitemap Options

Sección titulada «plugin::sitemap.sitemap-option — Sitemap Options»

Global sitemap configuration (baseUrl, excludedUrls, useSitemapIndex, sitemapDefinitions)

Kind: singleType · DB Table: strapi_5_sitemap_plugin_options · Admin Location: Internal (/admin/plugins/sitemap) · Draft & Publish: No · i18n: No

Atributo Tipo en Strapi Requerido Restricciones / Relación
baseUrl string No —
excludedUrls json No default: []
useSitemapIndex boolean No default: false
sitemapDefinitions json No default: []

Integración con el Content Manager de Strapi v5 (/admin/content-manager)

Sección titulada «Integración con el Content Manager de Strapi v5 (/admin/content-manager)»

Grupo en la Barra Lateral del Content Manager: Maps All Public Content Manager Collection Types & Single Types

Entidades y Componentes en el Content Manager

Sección titulada «Entidades y Componentes en el Content Manager»
  • plugin::sitemap.sitemap-content-type (Internal URL pattern mapping for Content Manager entities)
  • plugin::sitemap.sitemap-content-type-single-url (Internal custom static URL entries)
  • plugin::sitemap.sitemap-option (Internal global sitemap settings)

Mapa del Sitio XML y Hreflang — Vista de Entidades en el Content Manager de Strapi v5

Por Qué Este Plugin Crea e Integra Entidades en el Content Manager

Sección titulada «Por Qué Este Plugin Crea e Integra Entidades en el Content Manager»

@vicacha-devs/strapi-plugin-sitemap keeps its 3 configuration schemas (sitemap-content-type, sitemap-content-type-single-url, sitemap-option) hidden from the Content Manager sidebar (content-manager.visible: false) to prevent accidental schema edits, while dynamically reading published documents and i18n localizations from every public Content Manager Collection Type (api::* and plugin::*):

  • Automatic Sync with Content Manager Publishing: Whenever an editor publishes, updates, or unpublishes an Article, Event, Donation Campaign, or Resource Publication in Content Manager, /api/sitemap/sitemap.xml automatically reflects its lastmod and xhtml:link hreflang alternates.

Cómo Usarlo en el Content Manager de Strapi (Paso a Paso)

Sección titulada «Cómo Usarlo en el Content Manager de Strapi (Paso a Paso)»
  1. Publish Content in Content Manager: Author and publish localized entries in any api::* or plugin::* collection inside /admin/content-manager.
  2. Map URL Patterns in Sitemap Settings: Open /admin/settings/sitemap -> Collection Types tab and bind each Content Manager collection UID + locale to its frontend route pattern (e.g., /[locale]/articles/[slug]).
  3. Configure Sitemap Index, Custom & Excluded URLs: Use the General & Sitemap Index tab (Use sitemap index with multiple sitemaps + getSitemapBySlug in Users & Permissions → Public → Sitemap), Custom URLs tab, and Excluded URLs tab in /admin/settings/sitemap.

Sincronización entre el Content Manager y el Espacio del Plugin

Sección titulada «Sincronización entre el Content Manager y el Espacio del Plugin»

Casos de Uso en el Content Manager y Flujos Editoriales

Sección titulada «Casos de Uso en el Content Manager y Flujos Editoriales»

Content Manager Use Case 1 — Auto-Syndicating Published Content Manager Entries to Multilingual XML Sitemaps

Sección titulada «Content Manager Use Case 1 — Auto-Syndicating Published Content Manager Entries to Multilingual XML Sitemaps»
  • Para qué sirve y por qué usarlo: Ensure every newly published localized Event, Article, or Publication in Content Manager is immediately indexed with hreflang alternates.
  • Cómo ejecutarlo en el Content Manager: Publish the entry across es, en, ar, and tr in /admin/content-manager and verify its <url> block in GET /api/sitemap/sitemap.xml.
Sección titulada «Use Case 1 — Dynamic Multilingual Entity URL Pattern Mapping & xhtml:link Hreflang»
  • What it is for: Map any localized Strapi Content-Type entity (api::article.article, plugin::events.event, plugin::resources.publication) to dynamic URL patterns with automatic hreflang alternates.
  • How it works: In /admin/settings/sitemap (Collection Types tab), map a content type + langcode to a pattern (e.g., /[locale]/articles/[slug]), priority, and frequency (plugin::sitemap.sitemap-content-type).

XML Sitemap & Hreflang — Strapi v5 Admin Workspace

Use Case 2 — Hybrid Static + CMS Sitemap with Custom Single URLs & Excluded Paths

Sección titulada «Use Case 2 — Hybrid Static + CMS Sitemap with Custom Single URLs & Excluded Paths»
  • What it is for: Include static frontend routes (/es, /es/about-us, /en/about-us) alongside dynamic CMS entries in the same XML sitemap while excluding internal paths (/admin, /api, /404).
  • How it works: Add static route entries in the Custom URLs tab (plugin::sitemap.sitemap-content-type-single-url) and exclude internal routes in the Excluded URLs tab of /admin/settings/sitemap.

XML Sitemap & Hreflang — Strapi v5 Content Manager Entities

Use Case 3 — Multi-File Sitemap Index (sitemap-{slug}.xml) for Large Sites

Sección titulada «Use Case 3 — Multi-File Sitemap Index (sitemap-{slug}.xml) for Large Sites»
  • What it is for: Split large portals into dedicated sub-sitemaps (e.g., /api/sitemap/sitemap-pages.xml, /api/sitemap/sitemap-editorial-and-library.xml, /api/sitemap/sitemap-events-and-liturgy.xml) referenced by a master <sitemapindex>.
  • How it works: Enable Use sitemap index with multiple sitemaps (useSitemapIndex: true), grant getSitemapBySlug in Users & Permissions → Public → Sitemap, and define sitemapDefinitions in the General & Sitemap Index tab of /admin/settings/sitemap (PUT /sitemap/settings).

XML Sitemap & Hreflang — Strapi v5 Settings Panel

Método Ruta del Endpoint Ámbito Controlador Autenticación
GET /api/sitemap/sitemap.xml content-api controller.getSitemap Bearer JWT
GET /api/sitemap/sitemap-{slug}.xml content-api controller.getSitemapBySlug Bearer JWT
GET /sitemap/settings admin controller.getSettings Bearer JWT
PUT /sitemap/settings admin controller.updateSettings Bearer JWT
GET /sitemap/content-types admin controller.getContentTypes Bearer JWT
GET /sitemap/locales admin controller.getLocales Bearer JWT
GET /sitemap/allowed-fields admin controller.getAllowedFields Bearer JWT

7. Uso Programático en el Servidor (strapi.plugin y strapi.documents)

Sección titulada «7. Uso Programático en el Servidor (strapi.plugin y strapi.documents)»
// Registered services on plugin "sitemap": "service", "settings"
const pluginService = strapi.plugin("sitemap")?.service("service");
// Querying records via the Strapi v5 Document Service API
const records = await strapi.documents("plugin::sitemap.sitemap-content-type").findMany({
limit: 25,
sort: "createdAt:desc",
});
  • Cambios no visibles en el panel Admin: Ejecute pnpm strapi build después de editar config/plugins.ts.
  • Aislamiento de dependencias peer: Mantenga hoistPattern: ["*", "!@strapi/*"] en pnpm-workspace.yaml para evitar colisiones de contexto en React.
  • Verificación estricta de TypeScript: Ejecute pnpm check para validar admin/tsconfig.json y server/tsconfig.json.