You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: es/deploy/ci.mdx
+51-57Lines changed: 51 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,37 +45,38 @@ Para ver los resultados de esta verificación, visita la página de resultados d
45
45
### Vale
46
46
</div>
47
47
48
-
[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.
48
+
[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.
49
49
50
-
Mintlify permite ejecutar Vale automáticamente en una verificación de CI y mostrar los resultados como un estado de comprobación.
50
+
Mintlify admite ejecutar Vale automáticamente en una comprobación de CI y mostrar los resultados como un estado de comprobación.
51
51
52
52
<divid="configuration">
53
53
#### Configuración
54
54
</div>
55
55
56
-
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.
56
+
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.
57
57
58
58
Si no tienes un archivo de configuración de Vale, se cargará automáticamente la configuración predeterminada.
59
59
60
60
```mdx Default vale.ini configuration expandable
61
61
# Estilos de nivel superior
62
62
StylesPath = /app/styles
63
63
MinAlertLevel = suggestion
64
+
# Etiquetas HTML en línea a ignorar (code/tt para fragmentos de código, img/url para enlaces/imágenes, a para etiquetas ancla)
64
65
IgnoredScopes = code, tt, img, url, a
65
-
SkippedScopes = script, style, pre, figure, code
66
+
SkippedScopes = script, style, pre, figure
66
67
67
68
# Vocabularios
68
69
Vocab = Mintlify
69
70
70
-
# Esto es necesario ya que Vale no soporta oficialmente MDX
71
-
[formats]
72
-
mdx = md
71
+
# Paquetes
72
+
Packages = MDX
73
73
74
-
#Soporte para MDX
74
+
#Coincidir solo con MDX
75
75
[*.mdx]
76
76
BasedOnStyles = Vale
77
77
Vale.Terms = NO # Aplica reglas de mayúsculas muy estrictas, mantener desactivado
78
78
79
+
# Ignorar patrones de sintaxis específicos de JSX/MDX
El vocabulario predeterminado de Vale incluye las siguientes palabras.
95
+
95
96
```text Default Vale vocabulary expandable
96
97
Mintlify
97
98
mintlify
@@ -362,64 +363,67 @@ next
362
363
toc
363
364
```
364
365
366
+
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`.
367
+
368
+
*`accept.txt`: Palabras que deben ser ignoradas por el linter Vale. Por ejemplo, nombres de productos o términos poco comunes.
369
+
*`reject.txt`: Palabras que deben marcarse como errores. Por ejemplo, jerga o palabras que no son apropiadas para el tono de tu documentación.
370
+
365
371
```text Example Vale file structure
366
-
- docs.json
367
-
- .vale.ini
368
-
- styles/...
369
-
- text.md
372
+
/your-project
373
+
|- docs.json
374
+
|- .vale.ini
375
+
|- styles/
376
+
|- config/
377
+
|- vocabularies/
378
+
|- Mintlify/
379
+
|- accept.txt
380
+
|- reject.txt
381
+
|- example-page.mdx
370
382
```
371
383
372
384
```text Example monorepo Vale file structure
373
-
- main.ts
374
-
- docs/
375
-
- docs.json
376
-
- .vale.ini
377
-
- styles/...
378
-
- text.md
379
-
- test/
385
+
/your-monorepo
386
+
|- main.ts
387
+
|- docs/
388
+
|- docs.json
389
+
|- .vale.ini
390
+
|- styles/
391
+
|- config/
392
+
|- vocabularies/
393
+
|- Mintlify/
394
+
|- accept.txt
395
+
|- reject.txt
396
+
|- example-page.mdx
397
+
|- test/
380
398
```
381
399
382
400
<Note>
383
-
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.
401
+
Por razones de seguridad, no se admite el uso de un `stylesPath` absoluto ni de un `stylesPath` que incluya `..`.
402
+
403
+
Usa rutas relativas e incluye el `stylesPath` en tu repositorio.
384
404
</Note>
385
405
386
406
<divid="packages">
387
407
#### Paquetes
388
408
</div>
389
409
390
-
Vale admite una variedad de [paquetes](https://vale.sh/docs/keys/packages) que se pueden usar para detectar errores ortográficos y de estilo.
391
-
Cualquier paquete que incluyas en tu repositorio dentro del `stylesPath` correcto se instalará automáticamente y se usará en tu configuración de Vale.
410
+
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.
392
411
393
-
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.
412
+
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.
394
413
395
414
<Note>
396
-
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).
415
+
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).
397
416
</Note>
398
417
399
418
<divid="vale-with-mdx">
400
419
#### Vale con `MDX`
401
420
</div>
402
421
403
-
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.
404
-
405
-
Si prefieres no usar esta extensión, puedes agregar las siguientes líneas al archivo `.vale.ini` configurado:
406
-
407
-
```ini
408
-
[formats]
409
-
mdx = md
410
-
411
-
[*.mdx]
412
-
CommentDelimiters = {/*, */}
413
-
414
-
TokenIgnores = (?sm)((?:import|export) .+?$), \
415
-
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
416
-
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
417
-
418
-
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
419
-
(?sm)^({.+.*})
420
-
```
422
+
<Note>
423
+
La compatibilidad nativa con MDX requiere Vale 3.10.0 o posterior. Comprueba tu versión de Vale con `vale --version`.
424
+
</Note>
421
425
422
-
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.
426
+
Para usar los comentarios dentro del documento de Vale en archivos MDX, utiliza comentarios al estilo MDX `{/* ... */}`:
423
427
424
428
```mdx
425
429
{/* vale off */}
@@ -429,14 +433,4 @@ Este texto es ignorado por Vale
429
433
{/* vale on */}
430
434
```
431
435
432
-
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:
433
-
434
-
```mdx
435
-
{/* <!-- vale off --> */}
436
-
437
-
Este texto es ignorado por Vale
438
-
439
-
{/* <!-- vale on --> */}
440
-
```
441
-
442
-
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.
436
+
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.
Copy file name to clipboardExpand all lines: fr/deploy/ci.mdx
+52-58Lines changed: 52 additions & 58 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,37 +45,38 @@ Pour consulter les résultats de cette vérification, rendez-vous sur la page de
45
45
### Vale
46
46
</div>
47
47
48
-
[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.
48
+
[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.
49
49
50
-
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.
50
+
Mintlify permet d’exécuter automatiquement Vale dans un contrôle CI et d’afficher les résultats comme statut de contrôle.
51
51
52
52
<divid="configuration">
53
53
#### Configuration
54
54
</div>
55
55
56
-
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é.
56
+
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é.
57
57
58
-
Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est chargée automatiquement.
58
+
Si vous n’avez pas de fichier de configuration Vale, la configuration par défaut est automatiquement chargée.
59
59
60
60
```mdx Default vale.ini configuration expandable
61
61
# Styles de niveau supérieur
62
62
StylesPath = /app/styles
63
63
MinAlertLevel = suggestion
64
+
# Balises HTML en ligne à ignorer (code/tt pour les extraits de code, img/url pour les liens/images, a pour les balises d'ancrage)
64
65
IgnoredScopes = code, tt, img, url, a
65
-
SkippedScopes = script, style, pre, figure, code
66
+
SkippedScopes = script, style, pre, figure
66
67
67
68
# Vocabulaires
68
69
Vocab = Mintlify
69
70
70
-
# Requis car Vale ne prend pas officiellement en charge MDX
71
-
[formats]
72
-
mdx = md
71
+
# Packages
72
+
Packages = MDX
73
73
74
-
#Prise en charge de MDX
74
+
#Correspondre uniquement aux fichiers MDX
75
75
[*.mdx]
76
76
BasedOnStyles = Vale
77
77
Vale.Terms = NO # Applique des règles de capitalisation très strictes, laisser désactivé
78
78
79
+
# Ignorer les motifs de syntaxe spécifiques à JSX/MDX
Le vocabulaire par défaut de Vale comprend les mots suivants.
95
+
95
96
```text Default Vale vocabulary expandable
96
97
Mintlify
97
98
mintlify
@@ -362,64 +363,67 @@ next
362
363
toc
363
364
```
364
365
366
+
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`.
367
+
368
+
*`accept.txt` : Mots à ignorer par le linter Vale. Par exemple, des noms de produits ou des termes peu courants.
369
+
*`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.
370
+
365
371
```text Example Vale file structure
366
-
- docs.json
367
-
- .vale.ini
368
-
- styles/...
369
-
- text.md
372
+
/votre-projet
373
+
|- docs.json
374
+
|- .vale.ini
375
+
|- styles/
376
+
|- config/
377
+
|- vocabularies/
378
+
|- Mintlify/
379
+
|- accept.txt
380
+
|- reject.txt
381
+
|- page-exemple.mdx
370
382
```
371
383
372
384
```text Example monorepo Vale file structure
373
-
- main.ts
374
-
- docs/
375
-
- docs.json
376
-
- .vale.ini
377
-
- styles/...
378
-
- text.md
379
-
- test/
385
+
/your-monorepo
386
+
|- main.ts
387
+
|- docs/
388
+
|- docs.json
389
+
|- .vale.ini
390
+
|- styles/
391
+
|- config/
392
+
|- vocabularies/
393
+
|- Mintlify/
394
+
|- accept.txt
395
+
|- reject.txt
396
+
|- example-page.mdx
397
+
|- test/
380
398
```
381
399
382
400
<Note>
383
-
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.
401
+
Pour des raisons de sécurité, les `stylesPath` absolus ou les `stylesPath` contenant `..` ne sont pas pris en charge.
402
+
403
+
Utilisez des chemins relatifs et incluez le `stylesPath` dans votre référentiel.
384
404
</Note>
385
405
386
406
<divid="packages">
387
407
#### Packages
388
408
</div>
389
409
390
-
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.
391
-
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.
410
+
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.
392
411
393
-
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.
412
+
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.
394
413
395
414
<Note>
396
-
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.
415
+
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.
397
416
</Note>
398
417
399
418
<divid="vale-with-mdx">
400
419
#### Vale avec `MDX`
401
420
</div>
402
421
403
-
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.
404
-
405
-
Si vous préférez ne pas utiliser cette extension, vous pouvez ajouter les lignes suivantes au fichier `.vale.ini` configuré :
406
-
407
-
```ini
408
-
[formats]
409
-
mdx = md
410
-
411
-
[*.mdx]
412
-
CommentDelimiters = {/*, */}
413
-
414
-
TokenIgnores = (?sm)((?:import|export) .+?$), \
415
-
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
416
-
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
417
-
418
-
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
419
-
(?sm)^({.+.*})
420
-
```
422
+
<Note>
423
+
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`.
424
+
</Note>
421
425
422
-
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.
426
+
Pour utiliser les commentaires intégrés de Vale dans les fichiers MDX, utilisez les commentaires au format MDX `{/* ... */}` :
423
427
424
428
```mdx
425
429
{/* vale off */}
@@ -429,14 +433,4 @@ Ce texte est ignoré par Vale
429
433
{/* vale on */}
430
434
```
431
435
432
-
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 :
433
-
434
-
```mdx
435
-
{/* <!-- vale off --> */}
436
-
437
-
Ce texte est ignoré par Vale
438
-
439
-
{/* <!-- vale on --> */}
440
-
```
441
-
442
-
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.
436
+
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.
0 commit comments