diff --git a/es/optimize/seo.mdx b/es/optimize/seo.mdx index ab41e3e0a2..84690f481a 100644 --- a/es/optimize/seo.mdx +++ b/es/optimize/seo.mdx @@ -157,6 +157,36 @@ Para establecer metadatos predeterminados para todas las páginas, agrega el cam } ``` +
+ ### Meta tags con alcance a una carpeta +
+ +Para aplicar distintas meta tags a un subconjunto de páginas, como documentación versionada o un área específica de producto, agrega `seo.paths` a tu `docs.json`. Cada entrada apunta a una ruta de carpeta relativa a la raíz de la documentación y aplica sus etiquetas a todas las páginas dentro de esa carpeta. + +```json +"seo": { + "metatags": { + "og:image": "https://example.com/og/default.png" + }, + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] +} +``` + +Las etiquetas por carpeta prevalecen sobre `seo.metatags` para la misma clave, las rutas más largas prevalecen sobre las más cortas y el frontmatter de la página prevalece sobre ambas. Consulta [`seo.paths`](/es/organize/settings-seo#param-seo-paths) para ver las reglas de las rutas y sus excepciones. +
### Verificar la propiedad del sitio
@@ -255,6 +285,8 @@ keywords: ["keyword1", "keyword2"] El campo `keywords` debe estar en formato de lista YAML. Por ejemplo, `keywords: ["keyword1", "keyword2", "keyword3"]`. +El frontmatter también puede sobrescribir cualquier metaetiqueta personalizada declarada en tu `docs.json` bajo [`seo.metatags`](/es/organize/settings-seo#param-seo-metatags) o en una entrada coincidente de [`seo.paths`](/es/organize/settings-seo#param-seo-paths). Asigna a la misma clave un valor de cadena no vacío para reemplazar el valor global o el de la carpeta en esa página. El frontmatter no puede añadir metaetiquetas personalizadas que tu configuración no declare, y Mintlify ignora los valores que no sean cadenas. +
## Referencia de etiquetas meta comunes
diff --git a/es/organize/settings-seo.mdx b/es/organize/settings-seo.mdx index e07b87c9d2..647d14d009 100644 --- a/es/organize/settings-seo.mdx +++ b/es/organize/settings-seo.mdx @@ -46,6 +46,38 @@ Configuración de indexación y metadatos para motores de búsqueda. ``` + + Meta tags con alcance a una carpeta. Úsalo para aplicar distintas etiquetas a un subconjunto de páginas, como documentación versionada o un área específica de producto, sin tener que repetirlas en el frontmatter de cada página. + + Cada entrada tiene: + + - `path`: Ruta de carpeta relativa a la raíz de la documentación, como `guides/v2`, sin barra inicial ni final. Se aplica a todas las páginas dentro de esa carpeta. Cada ruta solo puede aparecer una vez. + - `metatags`: Meta tags añadidas a cada página bajo `path`, como pares clave-valor. Los valores deben ser cadenas no vacías. + + Precedencia, de menor a mayor: `seo.metatags`, luego las entradas de `seo.paths` que coincidan (las rutas más largas prevalecen sobre las más cortas cuando una página está en varias) y, por último, el frontmatter de la página. + + Las rutas se comparan con las URL de las páginas, por lo que las páginas traducidas en una carpeta de idioma necesitan sus propias entradas. Por ejemplo, `guides/v1` no se aplica a `es/guides/v1`. + + Mintlify ignora la clave `canonical` en las entradas de `seo.paths`. Define una URL canónica para todo el sitio en `seo.metatags` o una URL canónica por página en el frontmatter. + + ```json + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] + ``` + + Organización utilizada como entidad editora en los [datos estructurados](/es/optimize/seo#structured-data) que se emiten en cada página. Todos los campos son opcionales. Cuando se omiten, Mintlify deriva la organización a partir del nombre de tu sitio, el logo de la documentación y la URL del sitio. diff --git a/fr/optimize/seo.mdx b/fr/optimize/seo.mdx index 4411b744f2..225ab30950 100644 --- a/fr/optimize/seo.mdx +++ b/fr/optimize/seo.mdx @@ -157,6 +157,36 @@ Pour définir des balises méta par défaut pour toutes les pages, ajoutez le ch } ``` +
+ ### Balises méta limitées à un dossier +
+ +Pour appliquer des balises méta différentes à un sous-ensemble de pages, comme une documentation versionnée ou un domaine produit spécifique, ajoutez `seo.paths` à votre `docs.json`. Chaque entrée cible un chemin de dossier relatif à la racine de la documentation et applique ses balises à toutes les pages sous ce dossier. + +```json +"seo": { + "metatags": { + "og:image": "https://example.com/og/default.png" + }, + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] +} +``` + +Les balises par dossier l'emportent sur `seo.metatags` pour la même clé, les chemins plus longs l'emportent sur les plus courts, et le frontmatter de la page l'emporte sur les deux. Consultez [`seo.paths`](/fr/organize/settings-seo#param-seo-paths) pour les règles de chemin et leurs exceptions. +
### Vérifier la propriété du site
@@ -255,6 +285,8 @@ keywords: ["mot-clé1", "mot-clé2"] Le champ `keywords` doit être formaté comme un tableau YAML. Par exemple, `keywords: ["keyword1", "keyword2", "keyword3"]`. +Le frontmatter peut aussi remplacer toute balise méta personnalisée déclarée dans votre `docs.json` sous [`seo.metatags`](/fr/organize/settings-seo#param-seo-metatags) ou dans une entrée correspondante de [`seo.paths`](/fr/organize/settings-seo#param-seo-paths). Attribuez à la même clé une valeur de type chaîne non vide pour remplacer la valeur globale ou celle du dossier sur cette page. Le frontmatter ne peut pas ajouter de balises méta personnalisées que votre configuration ne déclare pas, et Mintlify ignore les valeurs qui ne sont pas des chaînes. +
## Référence des balises meta courantes
diff --git a/fr/organize/settings-seo.mdx b/fr/organize/settings-seo.mdx index 21cfc29a2a..bb6f49100b 100644 --- a/fr/organize/settings-seo.mdx +++ b/fr/organize/settings-seo.mdx @@ -46,6 +46,38 @@ Paramètres d'indexation et de métadonnées pour les moteurs de recherche. ``` + + Balises meta limitées à un dossier. Utilisez ce champ pour appliquer des balises différentes à un sous-ensemble de pages, comme une documentation versionnée ou un domaine produit spécifique, sans les répéter dans le frontmatter de chaque page. + + Chaque entrée contient : + + - `path` : Chemin de dossier relatif à la racine de la documentation, comme `guides/v2`, sans barre oblique au début ni à la fin. S'applique à toutes les pages sous ce dossier. Chaque chemin ne peut apparaître qu'une seule fois. + - `metatags` : Balises meta ajoutées à chaque page sous `path`, sous forme de paires clé-valeur. Les valeurs doivent être des chaînes non vides. + + Priorité, du plus faible au plus élevé : `seo.metatags`, puis les entrées de `seo.paths` correspondantes (les chemins plus longs l'emportent sur les plus courts lorsqu'une page est incluse dans plusieurs), puis le frontmatter de la page. + + Les chemins sont comparés aux URL des pages : les pages traduites dans un dossier de langue ont donc besoin de leurs propres entrées. Par exemple, `guides/v1` ne s'applique pas à `fr/guides/v1`. + + Mintlify ignore la clé `canonical` dans les entrées de `seo.paths`. Définissez une URL canonique pour tout le site dans `seo.metatags` ou une URL canonique par page dans le frontmatter. + + ```json + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] + ``` + + Organisation utilisée comme entité éditrice dans les [données structurées](/fr/optimize/seo#structured-data) émises sur chaque page. Tous les champs sont facultatifs. Lorsqu'ils sont omis, Mintlify dérive l'organisation du nom de votre site, du logo de la documentation et de l'URL du site. diff --git a/optimize/seo.mdx b/optimize/seo.mdx index 66671d2f81..4d96b8ea1b 100644 --- a/optimize/seo.mdx +++ b/optimize/seo.mdx @@ -147,6 +147,34 @@ To set default meta tags for all pages, add the `metatags` field to your `docs.j } ``` +### Folder-scoped meta tags + +To apply different meta tags to a subset of pages, such as versioned docs or a specific product area, add `seo.paths` to your `docs.json`. Each entry targets a folder path relative to the docs root and applies its tags to every page under that folder. + +```json +"seo": { + "metatags": { + "og:image": "https://example.com/og/default.png" + }, + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] +} +``` + +Folder tags override `seo.metatags` for the same key, longer paths override shorter ones, and page frontmatter overrides both. See [`seo.paths`](/organize/settings-seo#param-seo-paths) for path rules and exceptions. + ### Verify site ownership To verify your site with services like Google Search Console, Bing Webmaster Tools, or other search engines, add the verification meta tag to `seo.metatags` in your `docs.json`. Mintlify injects the tag into every page. @@ -239,6 +267,8 @@ keywords: ["keyword1", "keyword2"] You must format the `keywords` field as a YAML array. For example, `keywords: ["keyword1", "keyword2", "keyword3"]`. +Frontmatter can also override any custom meta tag declared in your `docs.json` under [`seo.metatags`](/organize/settings-seo#param-seo-metatags) or a matching [`seo.paths`](/organize/settings-seo#param-seo-paths) entry. Set the same key to a non-empty string to replace the site-wide or folder value on that page. Frontmatter can't add custom meta tags that your config doesn't declare, and Mintlify ignores non-string values. + ## Common meta tags reference Below is a comprehensive list of meta tags you can add to your `docs.json`. These meta tags help improve your site's SEO, social sharing, and browser compatibility. diff --git a/organize/settings-seo.mdx b/organize/settings-seo.mdx index f523445992..4d37d80bf1 100644 --- a/organize/settings-seo.mdx +++ b/organize/settings-seo.mdx @@ -46,6 +46,38 @@ Search engine indexing and metadata settings. ``` + + Meta tags scoped to a folder. Use this to apply different tags to a subset of pages, such as versioned docs or a specific product area, without repeating them in page frontmatter. + + Each entry has: + + - `path`: Folder path relative to the docs root, like `guides/v2`, with no leading or trailing slash. Applies to every page under that folder. Each path can appear only once. + - `metatags`: Meta tags added to every page under `path`, as key-value pairs. Values must be non-empty strings. + + Precedence, from lowest to highest: `seo.metatags`, then matching `seo.paths` entries (longer paths override shorter ones when a page is under multiple), then page frontmatter. + + Paths match page URLs, so translated pages in a language folder need their own entries. For example, `guides/v1` doesn't apply to `es/guides/v1`. + + Mintlify ignores a `canonical` key in `seo.paths` entries. Set a site-wide canonical in `seo.metatags` or a per-page canonical in frontmatter. + + ```json + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] + ``` + + The organization used as the publisher entity in the [structured data](/optimize/seo#structured-data) emitted on every page. All fields are optional. If you omit this object, Mintlify derives the organization from your site name, docs logo, and site URL. diff --git a/zh/optimize/seo.mdx b/zh/optimize/seo.mdx index e436298e64..48a2297bcb 100644 --- a/zh/optimize/seo.mdx +++ b/zh/optimize/seo.mdx @@ -157,6 +157,36 @@ description: "Your page description" } ``` +
+ ### 作用于文件夹的元标签 +
+ +要为一部分页面（例如版本化文档或特定的产品区域）应用不同的元标签，请在 `docs.json` 中添加 `seo.paths`。每个条目指向相对于文档根目录的文件夹路径，并将其标签应用到该文件夹下的每个页面。 + +```json +"seo": { + "metatags": { + "og:image": "https://example.com/og/default.png" + }, + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] +} +``` + +对于相同的键，文件夹级标签会覆盖 `seo.metatags`，较长的路径会覆盖较短的路径，页面的 frontmatter 会覆盖上述两者。路径规则和例外情况请参见 [`seo.paths`](/zh/organize/settings-seo#param-seo-paths)。 +
### 验证站点所有权
@@ -255,6 +285,8 @@ keywords: ["关键词1", "关键词2"] `keywords` 字段必须格式化为 YAML 数组。例如：`keywords: ["keyword1", "keyword2", "keyword3"]`。 +frontmatter 也可以覆盖 `docs.json` 中在 [`seo.metatags`](/zh/organize/settings-seo#param-seo-metatags) 或匹配的 [`seo.paths`](/zh/organize/settings-seo#param-seo-paths) 条目下声明的任何自定义元标签。为相同的键设置一个非空字符串值，即可在该页面上替换站点级或文件夹级的值。frontmatter 不能添加配置中未声明的自定义元标签，Mintlify 会忽略非字符串值。 +
## 常用 meta 标签参考
diff --git a/zh/organize/settings-seo.mdx b/zh/organize/settings-seo.mdx index 55f1af69b3..8db43f635e 100644 --- a/zh/organize/settings-seo.mdx +++ b/zh/organize/settings-seo.mdx @@ -46,6 +46,38 @@ keywords: ["SEO", "搜索", "索引", "meta 标签", "描述", "时间戳", "最 ``` + + 作用范围限定为某个文件夹的 meta 标签。使用它可以为一部分页面（例如版本化文档或特定的产品区域）应用不同的标签，而无需在每个页面的 frontmatter 中重复设置。 + + 每个条目包含： + + - `path`：相对于文档根目录的文件夹路径，例如 `guides/v2`，开头和结尾都不能有斜杠。将应用于该文件夹下的每个页面。每个路径只能出现一次。 + - `metatags`：以键值对形式提供的 meta 标签，将添加到 `path` 下的每个页面。值必须是非空字符串。 + + 优先级从低到高依次为：`seo.metatags`、匹配的 `seo.paths` 条目（当页面位于多个条目下时，较长的路径优先于较短的路径），最后是页面的 frontmatter。 + + 路径与页面 URL 进行匹配，因此语言文件夹中的翻译页面需要单独的条目。例如，`guides/v1` 不会应用于 `zh/guides/v1`。 + + Mintlify 会忽略 `seo.paths` 条目中的 `canonical` 键。请在 `seo.metatags` 中设置站点级规范 URL，或在 frontmatter 中设置单个页面的规范 URL。 + + ```json + "paths": [ + { + "path": "guides/v1", + "metatags": { + "robots": "noindex" + } + }, + { + "path": "guides/v2", + "metatags": { + "og:image": "https://example.com/og/v2.png" + } + } + ] + ``` + + 用作每个页面所发出[结构化数据](/zh/optimize/seo#structured-data)中发布者实体的组织。所有字段均为可选。省略时，Mintlify 会根据你的站点名称、文档 logo 和站点 URL 推导组织。