Skip to content

CLI — Documentos ​

translate-docs ​

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

Traduz markdown, MDX, .astro, JSON de catálogo Docusaurus opcional (docusaurusCatalogDir), _meta.ts/dicionário Nextra opcional .ts e catálogo de tema VitePress opcional para cada bloco docs.

Principais opções: -l, -j, -b, --prompt-format, --force, --force-update, --check-cache, --recheck-glossary-warnings, -p / -f, --dry-run

-j: número máximo de localidades paralelas; -b: número máximo de chamadas de API em lote paralelas por arquivo. --prompt-format: formato de transmissão em lote (xml | json-array | json-object).

Ver também: Comportamento do cache e sinalizadores translate-docs, Formato de prompt em lote


write-heading-ids ​

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

Requer pelo menos um bloco docs[]. Coleta .md / .mdx sob o contentPaths de cada bloco (respeita .translate-ignore). Por padrão, insere uma linha de âncora HTML <a id="slug"></a> imediatamente antes de cada título ATX plano # (ignora títulos dentro de blocos de código cercados). IDs de título existentes de qualquer forma (linha de âncora HTML, sufixo clássico {#id}, comentário MDX {/* #id */}) são substituídos pelo estilo selecionado; o slug é sempre derivado do texto do título atual. Quando várias âncoras HTML são empilhadas acima de um título, apenas a âncora para o texto do título atual é mantida, e os links de markdown no repositório que apontavam para um ID removido são atualizados para o ID que permanece. Um <a id> que não está diretamente acima de um título é deixado no lugar. Com --slug-style mdx-comment, escreve um sufixo de comentário MDX do Docusaurus na linha do título (mesmo algoritmo de slug estilo GitHub) e remove o bloco de âncora HTML precedente, quando presente. --remove remove todas essas formas de ID de título e não escreve nada em seu lugar.

Após atualizar os arquivos de origem, o comando também percorre o markdown traduzido existente de cada localidade (mesmo mapeamento de caminho docsOutput que translate-docs). Ele copia os IDs de cabeçalho do idioma de origem para os cabeçalhos ATX correspondentes na ordem do documento — ele nunca converte o título traduzido em slug — e move um {#id} / {/* #id */} no meio do cabeçalho (ou um HTML <a id> perdido) de volta para o formato que o Docusaurus ou o estilo escolhido espera. O idioma de origem é sourceLocale e pode ser qualquer idioma. Arquivos traduzidos ausentes são ignorados. --remove também remove os IDs de cabeçalho desses arquivos traduzidos, incluindo tokens mal posicionados no meio da linha.

Quando os IDs de cabeçalho de um arquivo traduzido são reposicionados ou reparados, o segmento traduzido em cache correspondente (identificado pelo hash do segmento de origem) também é atualizado, se o conteúdo de origem e os conteúdos traduzidos antigo e novo tiverem o mesmo número de segmentos. Uma incompatibilidade na contagem ignora esse arquivo e localidade. Um sync --force-update posterior então remonta o arquivo a partir da linha de cache atualizada.

Opções principais: -p / --path, -f / --file, --slug-style, --remove, --dry-run

--slug-style: github (padrão; doctoc / anchor-markdown-header), bitbucket, gitlab, pymdown, azure-devops, mdx-comment (sufixo {/* #… */} do Docusaurus). Com pymdown, --pymdown-case opcional, --pymdown-normalize, --pymdown-percent-encode / --no-pymdown-percent-encode. --remove não pode ser combinado com --pymdown-*.

Ver também: Links de âncora


check-markdown ​

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

Verifica markdown/MDX em cada contentPaths do bloco docs[] (mesma descoberta que translate-docs, respeita .translate-ignore): emparelhamento de delimitadores, código inline não fechado e STRONG_OUTSIDE_LINK quando **/__ envolvem um link [text](url).

Imprime relativePath:line: [ISSUE_CODE] message linhas para stderr; sai com o código 1 se algum problema for encontrado. --json: Relatório JSON em stdout. Escreve markdown_source_issues em cacheDir, a menos que --no-cache. -v adiciona hashes de origem às linhas de stderr.

Opções principais: -p / --path, -f / --file, --json, --no-cache

Ver também: Problemas de Markdown

Lançado sob a Licença MIT.