Skip to content

CLI — Documents ​

translate-docs ​

Synopsis : ai-i18n-tools translate-docs [options]

Traduit le Markdown, le MDX, .astro, le JSON de catalogue Docusaurus facultatif (docusaurusCatalogDir), le _meta.ts/dictionnaire Nextra facultatif (.ts) et le catalogue de thèmes VitePress facultatif pour chaque bloc docs.

Options clés : -l, -j, -b, --prompt-format, --force, --force-update, --check-cache, --recheck-glossary-warnings, -p / -f, --dry-run

-j : nombre maximal de locales parallèles ; -b : nombre maximal d'appels d'API par lot parallèles par fichier. --prompt-format : format de transmission par lot (xml | json-array | json-object).

Voir aussi : Comportement du cache et indicateurs translate-docs, Format d'invite par lot


write-heading-ids ​

Synopsis : ai-i18n-tools write-heading-ids [options]

Nécessite au moins un bloc docs[]. Collecte .md / .mdx sous le contentPaths de chaque bloc (respecte .translate-ignore). Par défaut, insère une ligne d'ancrage HTML <a id="slug"></a> immédiatement avant chaque titre ATX plat # (ignore les titres à l'intérieur des blocs de code clôturés). Les ID de titre existants de toute forme (ligne d'ancrage HTML, suffixe {#id} classique, commentaire MDX {/* #id */}) sont remplacés par le style sélectionné ; le slug est toujours dérivé du texte du titre actuel. Lorsque plusieurs ancres HTML sont empilées au-dessus d'un titre, seule l'ancre pour le texte du titre actuel est conservée, et les liens Markdown internes au dépôt qui pointaient vers un ID supprimé sont mis à jour vers l'ID qui reste. Un <a id> qui n'est pas directement au-dessus d'un titre est laissé en place. Avec --slug-style mdx-comment, écrit un suffixe de commentaire MDX Docusaurus sur la ligne du titre à la place (même algorithme de slug de style GitHub) et supprime le bloc d'ancrage HTML précédent s'il est présent. --remove supprime toutes ces formes d'ID de titre et n'écrit rien à leur place.

Après la mise à jour des fichiers source, la commande parcourt également le markdown traduit existant de chaque locale (même mappage de chemin docsOutput que translate-docs). Elle copie les identifiants de titre de la locale source sur les titres ATX correspondants dans l'ordre du document — elle ne slugifie jamais le titre traduit — et déplace un {#id} / {/* #id */} (ou un <a id> HTML égaré) au milieu d'un titre vers la forme attendue par Docusaurus / le style choisi. La langue source est sourceLocale et peut être n'importe quelle langue. Les fichiers traduits manquants sont ignorés. --remove supprime également les identifiants de titre de ces fichiers traduits, y compris les jetons mal placés en milieu de ligne.

Lorsqu'un fichier traduit voit ses identifiants de titre repositionnés ou réparés, le segment traduit mis en cache correspondant (identifié par le hachage du segment source) est également mis à jour, si le contenu source et les anciens et nouveaux contenus traduits ont le même nombre de segments. Une non-correspondance du nombre ignore ce fichier et cette locale. Un sync --force-update ultérieur réassemble ensuite le fichier à partir de la ligne de cache mise à jour.

Options clés : -p / --path, -f / --file, --slug-style, --remove, --dry-run

--slug-style : github (par défaut ; doctoc / anchor-markdown-header), bitbucket, gitlab, pymdown, azure-devops, mdx-comment (suffixe Docusaurus {/* #… */}). Avec pymdown, --pymdown-case facultatif, --pymdown-normalize, --pymdown-percent-encode / --no-pymdown-percent-encode. --remove ne peut pas être combiné avec --pymdown-*.

Voir aussi : Liens d'ancrage


check-markdown ​

Synopsis : ai-i18n-tools check-markdown [options]

Analyse le Markdown/MDX sous le contentPaths de chaque bloc docs[] (même découverte que translate-docs, respecte .translate-ignore) : appariement des délimiteurs, code en ligne non fermé et STRONG_OUTSIDE_LINK lorsque **/__ enveloppent un lien [text](url).

Affiche relativePath:line: [ISSUE_CODE] message lignes sur stderr ; quitte avec le code 1 si un problème est détecté. --json : rapport JSON sur stdout. Écrit markdown_source_issues dans cacheDir sauf si --no-cache. -v ajoute des hachages source aux lignes stderr.

Options clés : -p / --path, -f / --file, --json, --no-cache

Voir aussi : Problèmes Markdown

Publié sous licence MIT.