Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions create/text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@

This is useful when you want stable anchor links that don't change if you update the heading text, or when you need shorter, more memorable anchors.

Custom IDs preserve the casing and separators you write, so `camelCase`, `snake_case`, and `kebab-case` are all kept as-is. This makes it easier to migrate anchor links from other documentation tools without breaking inbound links.

```mdx
## Connection settings {#camelCaseId}
## Query options {#snake_case_id}
## Advanced usage {#kebab-case-id}
```

Auto-generated IDs (headings without `{#id}`) are unchanged—they continue to be lowercased and hyphenated.

Check warning on line 47 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L47

In general, use active voice instead of passive voice ('are unchanged').

Check warning on line 47 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L47

In general, use active voice instead of passive voice ('be lowercased').

Check warning on line 47 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L47

Did you really mean 'lowercased'?

### Disabling anchor links

By default, headers include clickable anchor links that allow users to link directly to specific sections. You can disable these anchor links using the `noAnchor` prop in HTML or React headers.
Expand Down
10 changes: 10 additions & 0 deletions es/create/text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ El ID personalizado reemplaza al anclaje generado automáticamente, por lo que p

Esto es útil cuando deseas enlaces de anclaje estables que no cambien al actualizar el texto del encabezado, o cuando necesitas anclajes más cortos y fáciles de recordar.

Los IDs personalizados preservan las mayúsculas y los separadores que escribas, por lo que `camelCase`, `snake_case` y `kebab-case` se conservan tal cual. Esto facilita migrar enlaces de anclaje desde otras herramientas de documentación sin romper los enlaces entrantes.

```mdx
## Connection settings {#camelCaseId}
## Query options {#snake_case_id}
## Advanced usage {#kebab-case-id}
```

Los IDs generados automáticamente (encabezados sin `{#id}`) no cambian: siguen convirtiéndose a minúsculas y con guiones.

<div id="disabling-anchor-links">
### Desactivar enlaces de anclaje
</div>
Expand Down
4 changes: 3 additions & 1 deletion es/guides/linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ Sobrescribe el anclaje generado automáticamente para cualquier encabezado añad
## Configuration options {#config}
```

Este encabezado es accesible en `#config` en lugar de `#configuration-options`. Los IDs personalizados mantienen los enlaces de anclaje estables cuando actualizas el texto del encabezado—útil para encabezados a los que enlazas frecuentemente. Consulta [Formatear texto](/es/create/text#custom-heading-ids) para más detalles.
Este encabezado es accesible en `#config` en lugar de `#configuration-options`. Los IDs personalizados mantienen los enlaces de anclaje estables cuando actualizas el texto del encabezado—útil para encabezados a los que enlazas frecuentemente.

Los IDs personalizados preservan las mayúsculas, por lo que `{#camelCaseId}`, `{#snake_case_id}` y `{#kebab-case-id}` se conservan tal cual los escribes. Esto es útil al migrar enlaces de anclaje desde otras plataformas de documentación. Consulta [Formatear texto](/es/create/text#custom-heading-ids) para más detalles.

<div id="deep-links">
## Enlaces profundos
Expand Down
10 changes: 10 additions & 0 deletions fr/create/text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ L'ID personnalisé remplace l'ancrage généré automatiquement. Vous pouvez ain

Cela est utile lorsque vous souhaitez des liens d'ancrage stables qui ne changent pas si vous modifiez le texte du titre, ou lorsque vous avez besoin d'ancrages plus courts et plus faciles à retenir.

Les IDs personnalisés préservent la casse et les séparateurs que vous écrivez, donc `camelCase`, `snake_case` et `kebab-case` sont conservés tels quels. Cela facilite la migration des liens d'ancrage depuis d'autres outils de documentation sans casser les liens entrants.

```mdx
## Connection settings {#camelCaseId}
## Query options {#snake_case_id}
## Advanced usage {#kebab-case-id}
```

Les IDs générés automatiquement (titres sans `{#id}`) restent inchangés : ils continuent d'être mis en minuscules et séparés par des tirets.

<div id="disabling-anchor-links">
### Désactivation des liens d’ancrage
</div>
Expand Down
4 changes: 3 additions & 1 deletion fr/guides/linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ Remplacez l'ancrage généré automatiquement pour n'importe quel titre en ajout
## Configuration options {#config}
```

Ce titre est accessible à `#config` au lieu de `#configuration-options`. Les IDs personnalisés maintiennent les liens d'ancrage stables lorsque vous mettez à jour le texte du titre—utile pour les titres vers lesquels vous liez fréquemment. Consultez [Formater le texte](/fr/create/text#custom-heading-ids) pour plus de détails.
Ce titre est accessible à `#config` au lieu de `#configuration-options`. Les IDs personnalisés maintiennent les liens d'ancrage stables lorsque vous mettez à jour le texte du titre—utile pour les titres vers lesquels vous liez fréquemment.

Les IDs personnalisés préservent la casse, donc `{#camelCaseId}`, `{#snake_case_id}` et `{#kebab-case-id}` sont conservés tels que vous les écrivez. Cela est utile lors de la migration de liens d'ancrage depuis d'autres plateformes de documentation. Consultez [Formater le texte](/fr/create/text#custom-heading-ids) pour plus de détails.

<div id="deep-links">
## Liens profonds
Expand Down
4 changes: 3 additions & 1 deletion guides/linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,9 @@
## Configuration options {#config}
```

This heading is reachable at `#config` instead of `#configuration-options`. Custom IDs keep anchor links stable when you update heading text—useful for headings you link to frequently. See [Format text](/create/text#custom-heading-ids) for more details.
This heading is reachable at `#config` instead of `#configuration-options`. Custom IDs keep anchor links stable when you update heading text—useful for headings you link to frequently.

Custom IDs preserve casing, so `{#camelCaseId}`, `{#snake_case_id}`, and `{#kebab-case-id}` are kept as-written. This is helpful when migrating anchor links from other documentation platforms. See [Format text](/create/text#custom-heading-ids) for more details.

## Deep links

Expand Down Expand Up @@ -142,7 +144,7 @@

### Link prerequisites explicitly

When a page assumes prior steps, link to them at the top rather than assuming users will find them:

Check warning on line 147 in guides/linking.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/linking.mdx#L147

Avoid using 'will'.

```mdx
## Prerequisites
Expand All @@ -156,7 +158,7 @@

### Build topic clusters

Link related content together to help users—and search engines—understand how your documentation is organized:

Check warning on line 161 in guides/linking.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/linking.mdx#L161

In general, use active voice instead of passive voice ('is organized').

```mdx
## Related topics
Expand Down Expand Up @@ -215,7 +217,7 @@
</Accordion>

<Accordion title="What happens to bookmarked links when I reorganize my documentation?">
Without redirects, bookmarked and shared links become 404 errors. Set up redirects in your `docs.json` whenever you move or rename a page. Redirects are cheap to add and prevent a poor user experience for anyone who linked to your documentation from an external source—blog posts, Stack Overflow answers, internal wikis.

Check warning on line 220 in guides/linking.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/linking.mdx#L220

Use the Oxford comma in 'Without redirects, bookmarked and'.
</Accordion>

<Accordion title="How many internal links should a page have?">
Expand Down
10 changes: 10 additions & 0 deletions zh/create/text.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ keywords: ["Markdown 格式", "文本样式", "标题", "锚点链接", "custom

当你希望锚点链接保持稳定、不因标题文本更新而变化时,或者需要更短、更易记的锚点时,此功能非常有用。

自定义 ID 会保留你所写的大小写和分隔符,因此 `camelCase`、`snake_case` 和 `kebab-case` 都会按原样保留。这便于从其他文档工具迁移锚点链接,而不会破坏入站链接。

```mdx
## Connection settings {#camelCaseId}
## Query options {#snake_case_id}
## Advanced usage {#kebab-case-id}
```

自动生成的 ID(没有 `{#id}` 的标题)保持不变——它们仍会被转换为小写并使用连字符。

<div id="disabling-anchor-links">
### 禁用锚点链接
</div>
Expand Down
4 changes: 3 additions & 1 deletion zh/guides/linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ Mintlify 通过将标题文本转换为小写、用连字符替换空格并删
## Configuration options {#config}
```

此标题可通过 `#config` 访问,而不是 `#configuration-options`。自定义 ID 在你更新标题文本时保持锚点链接稳定——这对你经常链接到的标题很有用。详情请参阅[格式化文本](/zh/create/text#custom-heading-ids)。
此标题可通过 `#config` 访问,而不是 `#configuration-options`。自定义 ID 在你更新标题文本时保持锚点链接稳定——这对你经常链接到的标题很有用。

自定义 ID 会保留大小写,因此 `{#camelCaseId}`、`{#snake_case_id}` 和 `{#kebab-case-id}` 都会按你所写的样式保留。这在从其他文档平台迁移锚点链接时很有用。详情请参阅[格式化文本](/zh/create/text#custom-heading-ids)。

<div id="deep-links">
## 深层链接
Expand Down
Loading