Skip to content
Merged
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
108 changes: 51 additions & 57 deletions es/deploy/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,37 +45,38 @@ Para ver los resultados de esta verificación, visita la página de resultados d
### Vale
</div>

[Vale](https://vale.sh/) es un linter de prosa de código abierto basado en reglas que admite una variedad de tipos de documentos, incluidos Markdown y MDX.
[Vale](https://vale.sh/) es un linter de prosa de código abierto basado en reglas que admite una variedad de tipos de documentos, incluidos Markdown y MDX. Usa Vale para comprobar la coherencia del estilo y el tono en tu documentación.

Mintlify permite ejecutar Vale automáticamente en una verificación de CI y mostrar los resultados como un estado de comprobación.
Mintlify admite ejecutar Vale automáticamente en una comprobación de CI y mostrar los resultados como un estado de comprobación.

<div id="configuration">
#### Configuración
</div>

Si tienes un archivo `.vale.ini` en el directorio raíz de contenido de tu implementación, la verificación de Vale CI utiliza ese archivo de configuración y cualquier archivo de configuración en el `stylesPath` que especifiques.
Si tienes un archivo `.vale.ini` en el directorio raíz de contenido de tu implementación, la verificación de Vale CI usa ese archivo de configuración y cualquier archivo de configuración en el `stylesPath` que especifiques.

Si no tienes un archivo de configuración de Vale, se cargará automáticamente la configuración predeterminada.

```mdx Default vale.ini configuration expandable
# Estilos de nivel superior
StylesPath = /app/styles
MinAlertLevel = suggestion
# Etiquetas HTML en línea a ignorar (code/tt para fragmentos de código, img/url para enlaces/imágenes, a para etiquetas ancla)
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code
SkippedScopes = script, style, pre, figure

# Vocabularios
Vocab = Mintlify

# Esto es necesario ya que Vale no soporta oficialmente MDX
[formats]
mdx = md
# Paquetes
Packages = MDX

# Soporte para MDX
# Coincidir solo con MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Aplica reglas de mayúsculas muy estrictas, mantener desactivado

# Ignorar patrones de sintaxis específicos de JSX/MDX
# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
Expand All @@ -84,14 +85,14 @@ TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Excluir:
# Excluir JSX multilínea y llaves
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

CommentDelimiters = {/*, */}
```

El vocabulario predeterminado de Vale incluye las siguientes palabras.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Inconsistent Vale vocabulary across language versions

The Vale vocabulary list contains inconsistent values across language versions. The Spanish and French versions use Github (line 102) and APIs (line 103), while the Chinese version correctly uses GitHub and API. Since Vale is case-sensitive and this vocabulary list is technical configuration (not translatable content), all versions must have identical values. The incorrect capitalization of Github will cause Vale to reject the correct GitHub spelling, and the plural/singular mismatch creates inconsistent linting behavior across localized documentation.

Additional Locations (1)

Fix in Cursor Fix in Web

```text Default Vale vocabulary expandable
Mintlify
mintlify
Expand Down Expand Up @@ -362,64 +363,67 @@ next
toc
```

Para agregar tu propio vocabulario a la configuración predeterminada, crea un directorio `styles/config/vocabularies/Mintlify` con los archivos `accept.txt` y `reject.txt`.

* `accept.txt`: Palabras que deben ser ignoradas por el linter Vale. Por ejemplo, nombres de productos o términos poco comunes.
* `reject.txt`: Palabras que deben marcarse como errores. Por ejemplo, jerga o palabras que no son apropiadas para el tono de tu documentación.

```text Example Vale file structure
- docs.json
- .vale.ini
- styles/...
- text.md
/your-project
|- docs.json
|- .vale.ini
|- styles/
|- config/
|- vocabularies/
|- Mintlify/
|- accept.txt
|- reject.txt
|- example-page.mdx
```

```text Example monorepo Vale file structure
- main.ts
- docs/
- docs.json
- .vale.ini
- styles/...
- text.md
- test/
/your-monorepo
|- main.ts
|- docs/
|- docs.json
|- .vale.ini
|- styles/
|- config/
|- vocabularies/
|- Mintlify/
|- accept.txt
|- reject.txt
|- example-page.mdx
|- test/
```

<Note>
Ten en cuenta que, por razones de seguridad, no se admiten `stylesPath` absolutos ni `stylesPath` que incluyan `..`. Usa rutas relativas e incluye el `stylesPath` en tu repositorio.
Por razones de seguridad, no se admite el uso de un `stylesPath` absoluto ni de un `stylesPath` que incluya `..`.

Usa rutas relativas e incluye el `stylesPath` en tu repositorio.
</Note>

<div id="packages">
#### Paquetes
</div>

Vale admite una variedad de [paquetes](https://vale.sh/docs/keys/packages) que se pueden usar para detectar errores ortográficos y de estilo.
Cualquier paquete que incluyas en tu repositorio dentro del `stylesPath` correcto se instalará automáticamente y se usará en tu configuración de Vale.
Vale es compatible con una variedad de [paquetes](https://vale.sh/docs/keys/packages), que puedes usar para detectar errores ortográficos y de estilo. Cualquier paquete que incluyas en tu repositorio bajo el `stylesPath` correcto se instala automáticamente y se utiliza en tu configuración de Vale.

Para los paquetes que no estén incluidos en tu repositorio, puedes especificar cualquiera del [registro de paquetes de Vale](https://vale.sh/explorer); se descargarán automáticamente y se usarán en tu configuración de Vale.
Para los paquetes que no estén incluidos en tu repositorio, puedes especificar cualquiera del [registro de paquetes de Vale](https://vale.sh/explorer); se descargarán automáticamente y se utilizarán en tu configuración de Vale.

<Note>
Ten en cuenta que, por razones de seguridad, no se admite la descarga automática de paquetes que no provengan del [registro de paquetes de Vale](https://vale.sh/explorer).
Por motivos de seguridad, **no** se admite la descarga automática de paquetes que no provengan del [registro de paquetes de Vale](https://vale.sh/explorer).
</Note>

<div id="vale-with-mdx">
#### Vale con `MDX`
</div>

Vale no admite `MDX` de forma nativa, pero el autor de Vale ha proporcionado una [extensión personalizada](https://github.com/errata-ai/MDX) para darle soporte.

Si prefieres no usar esta extensión, puedes agregar las siguientes líneas al archivo `.vale.ini` configurado:

```ini
[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
```
<Note>
La compatibilidad nativa con MDX requiere Vale 3.10.0 o posterior. Comprueba tu versión de Vale con `vale --version`.
</Note>

Para usar los comentarios en el documento de Vale, utiliza comentarios con estilo MDX `{/* ... */}`. Si en tu configuración usas el [ajuste](https://vale.sh/docs/keys/commentdelimiters) `CommentDelimiters = {/*, */}`, Vale interpretará automáticamente estos comentarios durante el análisis. Esto significa que puedes aprovechar fácilmente las funciones integradas de Vale, como omitir líneas o secciones.
Para usar los comentarios dentro del documento de Vale en archivos MDX, utiliza comentarios al estilo MDX `{/* ... */}`:

```mdx
{/* vale off */}
Expand All @@ -429,14 +433,4 @@ Este texto es ignorado por Vale
{/* vale on */}
```

Si decides no usar `CommentDelimiters` pero aun así usar los comentarios de Vale, debes envolver cualquier comentario de Vale en comentarios de MDX `{/* ... */}`. Por ejemplo:

```mdx
{/* <!-- vale off --> */}

Este texto es ignorado por Vale

{/* <!-- vale on --> */}
```

Estas etiquetas de comentario no son compatibles dentro de los componentes de Mintlify, pero funcionan correctamente en cualquier lugar del nivel base de un documento.
Vale reconoce y respeta automáticamente estos comentarios en los archivos MDX sin necesidad de configuración adicional. Usa los comentarios para omitir líneas o secciones que el linter deba ignorar.
110 changes: 52 additions & 58 deletions fr/deploy/ci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,37 +45,38 @@ Pour consulter les résultats de cette vérification, rendez-vous sur la page de
### Vale
</div>

[Vale](https://vale.sh/) est un linter de prose open source basé sur des règles, compatible avec divers types de documents, dont Markdown et MDX.
[Vale](https://vale.sh/) est un linter de prose open source basé sur des règles qui prend en charge un large éventail de types de documents, y compris Markdown et MDX. Utilisez Vale pour vérifier la cohérence du style et du ton de votre documentation.

Mintlify prend en charge l’exécution automatique de Vale dans une vérification CI et l’affichage des résultats sous forme d’état de vérification.
Mintlify permet d’exécuter automatiquement Vale dans un contrôle CI et d’afficher les résultats comme statut de contrôle.

<div id="configuration">
#### Configuration
</div>

Si vous avez un fichier `.vale.ini` à la racine du répertoire content de votre déploiement, le contrôle Vale CI utilise ce fichier de configuration ainsi que tout fichier de configuration présent dans le `stylesPath` que vous avez spécifié.
Si vous avez un fichier `.vale.ini` à la racine du répertoire de contenu de votre déploiement, la vérification Vale CI utilise ce fichier de configuration ainsi que tous les fichiers de configuration présents dans le `stylesPath` que vous avez spécifié.

Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est chargée automatiquement.
Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est automatiquement chargée.

```mdx Default vale.ini configuration expandable
# Styles de niveau supérieur
StylesPath = /app/styles
MinAlertLevel = suggestion
# Balises HTML en ligne à ignorer (code/tt pour les extraits de code, img/url pour les liens/images, a pour les balises d'ancrage)
IgnoredScopes = code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code
SkippedScopes = script, style, pre, figure

# Vocabulaires
Vocab = Mintlify

# Requis car Vale ne prend pas officiellement en charge MDX
[formats]
mdx = md
# Packages
Packages = MDX

# Prise en charge de MDX
# Correspondre uniquement aux fichiers MDX
[*.mdx]
BasedOnStyles = Vale
Vale.Terms = NO # Applique des règles de capitalisation très strictes, laisser désactivé

# Ignorer les motifs de syntaxe spécifiques à JSX/MDX
# `import ...`, `export ...`
# `<Component ... />`
# `<Component>...</Component>`
Expand All @@ -84,14 +85,14 @@ TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

# Exclure :
# Exclure le JSX multiligne et les accolades
# `<Component \n ... />`
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})

CommentDelimiters = {/*, */}
```

Le vocabulaire par défaut de Vale comprend les mots suivants.

```text Default Vale vocabulary expandable
Mintlify
mintlify
Expand Down Expand Up @@ -362,64 +363,67 @@ next
toc
```

Pour ajouter votre propre vocabulaire à la configuration par défaut, créez un répertoire `styles/config/vocabularies/Mintlify` contenant les fichiers `accept.txt` et `reject.txt`.

* `accept.txt` : Mots à ignorer par le linter Vale. Par exemple, des noms de produits ou des termes peu courants.
* `reject.txt` : Mots qui doivent être signalés comme des erreurs. Par exemple, du jargon ou des mots qui ne sont pas appropriés au ton de votre documentation.

```text Example Vale file structure
- docs.json
- .vale.ini
- styles/...
- text.md
/votre-projet
|- docs.json
|- .vale.ini
|- styles/
|- config/
|- vocabularies/
|- Mintlify/
|- accept.txt
|- reject.txt
|- page-exemple.mdx
```

```text Example monorepo Vale file structure
- main.ts
- docs/
- docs.json
- .vale.ini
- styles/...
- text.md
- test/
/your-monorepo
|- main.ts
|- docs/
|- docs.json
|- .vale.ini
|- styles/
|- config/
|- vocabularies/
|- Mintlify/
|- accept.txt
|- reject.txt
|- example-page.mdx
|- test/
```

<Note>
Pour des raisons de sécurité, les `stylesPath` absolus ou contenant `..` ne sont pas pris en charge. Utilisez des chemins relatifs et incluez le `stylesPath` dans votre référentiel.
Pour des raisons de sécurité, les `stylesPath` absolus ou les `stylesPath` contenant `..` ne sont pas pris en charge.

Utilisez des chemins relatifs et incluez le `stylesPath` dans votre référentiel.
</Note>

<div id="packages">
#### Packages
</div>

Vale prend en charge un éventail de [packages](https://vale.sh/docs/keys/packages), qui peuvent être utilisés pour détecter les fautes d’orthographe et les erreurs de style.
Tous les packages que vous incluez dans votre référentiel sous le `stylesPath` approprié sont automatiquement installés et pris en compte dans votre configuration Vale.
Vale prend en charge une gamme de [packages](https://vale.sh/docs/keys/packages), qui peuvent être utilisés pour détecter les fautes d’orthographe et les erreurs de style. Tous les packages que vous ajoutez à votre référentiel sous le `stylesPath` approprié sont automatiquement installés et utilisés dans votre configuration Vale.

Pour les packages qui ne figurent pas dans votre référentiel, vous pouvez spécifier n’importe quels packages depuis le [registre de packages Vale](https://vale.sh/explorer) ; ils sont alors automatiquement téléchargés et utilisés dans votre configuration Vale.
Pour les packages qui ne sont pas inclus dans votre référentiel, vous pouvez spécifier n’importe quel package du [registre de packages Vale](https://vale.sh/explorer), qui sera automatiquement téléchargé et utilisé dans votre configuration Vale.

<Note>
Veuillez noter que, pour des raisons de sécurité, le téléchargement automatique de packages ne provenant pas du [registre de packages Vale](https://vale.sh/explorer) n’est pas pris en charge.
Pour des raisons de sécurité, le téléchargement automatique de packages qui ne proviennent pas du [registre de packages Vale](https://vale.sh/explorer) n’est **pas** pris en charge.
</Note>

<div id="vale-with-mdx">
#### Vale avec `MDX`
</div>

Vale ne prend pas en charge `MDX` nativement, mais l’auteur de Vale a fourni une [extension personnalisée](https://github.com/errata-ai/MDX) pour l’ajouter.

Si vous préférez ne pas utiliser cette extension, vous pouvez ajouter les lignes suivantes au fichier `.vale.ini` configuré :

```ini
[formats]
mdx = md

[*.mdx]
CommentDelimiters = {/*, */}

TokenIgnores = (?sm)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({.+.*})
```
<Note>
La prise en charge native de MDX nécessite Vale 3.10.0 ou une version ultérieure. Vérifiez votre version de Vale avec `vale --version`.
</Note>

Pour utiliser les commentaires dans le document de Vale, utilisez des commentaires au format MDX `{/* ... */}`. Si vous utilisez le [paramètre](https://vale.sh/docs/keys/commentdelimiters) `CommentDelimiters = {/*, */}` dans votre configuration, Vale interprétera automatiquement ces commentaires lors de l’analyse. Cela signifie que vous pouvez facilement utiliser les fonctionnalités intégrées de Vale, comme ignorer des lignes ou des sections.
Pour utiliser les commentaires intégrés de Vale dans les fichiers MDX, utilisez les commentaires au format MDX `{/* ... */}` :

```mdx
{/* vale off */}
Expand All @@ -429,14 +433,4 @@ Ce texte est ignoré par Vale
{/* vale on */}
```

Si vous choisissez de ne pas utiliser `CommentDelimiters` tout en utilisant les commentaires de Vale, vous devez entourer tous les commentaires de Vale de commentaires MDX `{/* ... */}`. Par exemple :

```mdx
{/* <!-- vale off --> */}

Ce texte est ignoré par Vale

{/* <!-- vale on --> */}
```

Ces balises de commentaire ne sont pas prises en charge dans les composants Mintlify, mais elles fonctionneront correctement partout au niveau de base d’un document.
Vale reconnaît et respecte automatiquement ces commentaires dans les fichiers MDX sans configuration supplémentaire. Utilisez les commentaires pour ignorer les lignes ou sections qui doivent être ignorées par le linter.
Loading