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.

Opções principais: -l, -j, -b, --prompt-format, --force, --force-update, --check-cache, -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 # simples (ignora títulos dentro de blocos de código cercados). IDs de título existentes de qualquer forma (linha de âncora HTML, sufixo {#id} clássico, comentário MDX {/* #id */}) são substituídos pelo estilo selecionado; o slug é sempre derivado do texto do título atual. 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 uma âncora HTML precedente, se 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 (o mesmo mapeamento de caminho docsOutput que translate-docs). Ele copia os IDs de cabeçalho em inglês para os cabeçalhos ATX correspondentes na ordem do documento — nunca gera slugs do título traduzido — e move um {#id} / {/* #id */} no meio do cabeçalho (ou <a id> HTML extraviado) de volta para o formato que o Docusaurus / o estilo escolhido espera. Arquivos traduzidos ausentes são ignorados. --remove também remove os IDs de cabeçalho desses arquivos traduzidos, incluindo tokens de linha intermediária fora do lugar.

Quando os IDs de cabeçalho de um arquivo traduzido são reposicionados ou reparados, o segmento traduzido em cache correspondente (indexado pelo hash da fonte em inglês) também é atualizado, caso a fonte em inglês e os conteúdos traduzidos antigo e novo tenham o mesmo número de segmentos. Uma divergência na contagem faz com que esse arquivo e localidade sejam ignorados. 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 linhas relativePath:line: [ISSUE_CODE] message para stderr; código de saída 1 se houver algum problema. --json: relatório JSON para stdout. Grava 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.