Pular para o conteúdo principal

Liberando o Docusaurus i18n

· Leitura de 4 minutos
Sébastien Lorber

Hoje, lançamos oficialmente Docusaurus 2 i18n (internacionalização), como parte da 2.0.0-alpha.71.

O Docusaurus 2 agora atingiu paridade de recursos completos com o Docusaurus 1. 🎉 E logo, após algumas atualizações adicionais de infraestrutura e mais alguns testes, o primeiro Docusaurus 2 beta será lançado.

Fomos além, e o novo suporte i18n é ainda melhor do que no Docusaurus 1.

Nesta publicação, apresentaremos o fluxo de trabalho de tradução, explicando algumas decisões de design e monstrando sites de adoção antecipada que simplesmente foram ao vivo: Jest, Redwood, e Datagit.

Também dogfood para o i18n no próprio site do Docusaurus 2, e esta postagem já está disponível em Inglês e Francês!

Traduzir o seu site​

Você pode traduzir um site Docusaurus em 3 etapas simples:

  1. Configure: declare as localidades padrão e locais alternativos em docusaurus.config.js
  2. Traduza: coloque os arquivos de tradução no local correto do sistema de arquivos
  3. Deploy: faça build e deploy do seu site usando uma estratégia única ou multidomínio

O suporte para i18n é muito flexível e com base no sistema de arquivos.

O tutorial dei18n é a melhor maneira de começar, e fornecemos ajuda para usar Git ou Crowdin.

Decisões de design​

Os objetivos do sistema de i18n Docusaurus são:

  • Simples: basta colocar os arquivos traduzidos na localização correta do sistema de arquivos
  • Fluxos de trabalho de tradução flexíveis: use Git (monorepo, forks, ou submódulos), software SaaS, FTP
  • Opções de deploy flexíveis: única, vários domínios ou híbridos
  • Modular: permitir que autores do plugin forneçam suporte do i18n
  • Tempo de execução de baixa sobrecarga: a documentação é principalmente estática e não requer uma biblioteca JS pesada ou polyfills
  • Compilações escalonáveis: permite construir e implantar sites localizados de forma independente
  • Localizar recursos: uma imagem do seu site pode conter texto que deve ser traduzido
  • Nenhum acoplamento: não forçado a usar qualquer SaaS, mas as integrações são possíveis
  • Fácil de usar com o Crowdin: vários sites do Docusaurus 1 usam o Crowdin e podem migrar para a v2
  • Bom padrão de SEO: definimos cabeçalhos de SEO úteis como hreflang para você
  • Suporte RTL: localidades lendo de direita para esquerda (árabe, hebraico, etc.) são suportadas e fáceis de implementar
  • Default translations: classic theme labels are translated for you in many languages

Showcase​

Nós trabalhamos com alguns voluntários para alimentar o suporte i18n antes de liberá-lo.

Jest: Melhorando o Docusaurus​

Tornamos possível atualizar um site traduzido Docusaurus 1 para o Docusaurus 2.

Jest, usando o Docusaurus 1 e o Crowdin foi um desses sites.

A migração do Docusaurus 2 foi bem sucedida e o novo site agora é implantado em produção (post de anúncio).

Jest's website front page in Japanese

Redwood: adotando o Docusaurus​

Redwood é um framework Jamstack full-stack React.

Eles estavam procurando uma solução para criar uma plataforma de aprendizagem internacionalizada e se tornaram os primeiros a adotar o Docusaurus 2 i18n para learn.redwoodjs.com, usando Crowdin para traduzir para o francês.

Redwood's doc page in French

Datagit: usando suporte de LTR​

O sistema i18n deve funcionar com qualquer idioma, incluindo Idiomas Direita-para-esquerda.

Datagit.ir está usando Farsi, e uma opção simples de configuração é capaz de inverter o tema Docusaurus para adicionar o apoio necessário à Direita-para-esquerda.

Datagit's website in Persian, a right-to-left language. The sidebar appears on the right of the window and the TOC appears on the left.

Conclusão​

Esperamos sinceramente que você adote e goste do novo suporte i18n.

Esse recurso não foi fácil, e gostaríamos de agradecer a todos que se envolveram nesta jornada:

  • Alexey por sua ajuda para tornar o suporte i18n exaustivo e ainda melhor que a v1
  • Simen por se voluntariar e apoiar a migração Jest
  • Claire por adotar o Docusaurus 2 na nova plataforma Redwood e fornecer muitas sugestões
  • Massoud por revisar meu trabalho no LTR e adotá-lo no Datagit
  • Crowdin por seu apoio e vontade de melhorar a tradução do SaaS
  • À comunidade Docusaurus, pela paciência e toda a ajuda que recebemos pelo GitHub

Obrigado pela leitura.

🙏 E por favor, adicione seus novos sites do i18n à nossa página de showcase. Aceitamos todos os sites polidos do Docusaurus aqui, e estamos trabalhando em um projeto que permite que você filtre sites por recursos.