Pular para o conteúdo principal

Recapitulação do Docusaurus 2020

· Leitura de 6 minutos
Sébastien Lorber

2020 foi ótimo para o Docusaurus, apesar de um começo lamentável e um ano tumultuoso para todos.

Continuamos a investir no Docusaurus 2 e o fizemos atingir a paridade total de recursos com o Docusaurus 1.

Agora recomendamos Docusaurus 2 como a escolha padrão para iniciar um novo projeto Docusaurus e encorajar os usuários da v1 a migrar para Docusaurus 2.

Nós ainda estamos em alpha, mas espere boas notícias muito em breve!

Three Docusaurus plushies laid side-by-side on the table

Destaques do Docusaurus 2​

Trabalhámos sobre muitos aspectos este ano e gostaríamos de destacar os mais significativos:

  • i18n: traduza facilmente seu site Docusaurus, lançado em breve! (visualizar, doc)
  • Lista de versões no dropdown: ative o switch da versão contextual
  • Opções de versionamento: resolver os usuários mais comuns de pontos de dor com versionamento
  • Pesquisa contextual: pesquise na versão atual, use a nova experiência DocSearch 3
  • Páginas Markdown: use Markdown em vez de componentes React para criar páginas autônomas
  • Tema melhor: várias UI, UX e melhorias de acessibilidade
  • PWA: adicionar suporte offline ao seu site e torná-lo instalável
  • Falhar rápido: validação de configuração estrita, detectar links quebrados e evitar implantações de produção ruins
  • Multi-instância: use o plugin docs duas vezes em um único site (por exemplo, documentação SDK de iOS/Android)
  • CLI de Migração: automatize o upgrade do Docusaurus 1
  • CodeSandbox: Avalie o Docusaurus facilmente no seu navegador com new.docusaurus.io
  • Versões canário: use a tag npm @canary para usar a próxima versão antes de qualquer outra pessoa
  • TypeScript: adoção progressiva para código interno e melhoria no uso para usuários
  • Publish Infima: agora é de código aberto

Crescimento do Docusaurus 2​

O plano para reconstruir o Docusaurus do zero em 2019 foi pago após um início lento. O Docusaurus 2 foi amplamente adotado e tem anos de uso do Docusaurus 1.

Docusaurus v1 vs. v2 npm trends of the year 2020. The installations of Docusaurus v2 is visibly up-growing, while v1 is slightly downward. V1 starts at 15000 and ends at 10000, while v2 starts at 2000 and ends at 25000. The intersection happens around June 2020.

Notáveis projetos, startups, grandes empresas e indivíduos adotaram o Docusaurus 2 (showcase):

Nós ajudamos sites de grande escala do Docusaurus 1 a atualizarem, garantindo um caminho de migração adequado e paridade de recursos.

React Native foi atualizado com sucesso para o Docusaurus 2 (site v1 arquivado):

React Native's new website built with Docusaurus v2

Sites localizados do Docusaurus 1 (como Jest) serão capazes de atualizar também:

Jest's new website built with Docusaurus v2 in Japanese

Também vimos o primeiro site da direita-esquerda do Docusaurus 2 publicado:

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.

Atividade do GitHub​

  • Estrelas: 14632 → 20946 (+43.2% y/y)
  • Total de Contribuidores: 303 → 512 (+68.9% y/y). A maioria dos quais não são contribuidores do Facebook
  • Downloads semanais no npm: 2356 → 25592 (+986% y/y)
  • No GitHub, o Docusaurus 1 é usado por 6311 projetos (+62.9% y/y) enquanto o Docusaurus 2 é usado por 5039 projetos (+1940% y/y)

Colaboração com Major League Hacking​

Recebemos companheiros do Major League Hacking (MLH) há 2 temporadas.

Somos muito gratos pelas várias contribuições que eles fizeram, tais como:

  • Escrevendo as fundações da v1 para a migração de v2 CLI
  • Ajudando a migrar o site React Native de v1 para v2
  • Tornando a validação de configuração mais estrita e exaustiva, retornando mensagens de erro úteis
  • Adicionando suporte ao CodeSandbox
  • Melhorando os pipelines de CI: tamanho da compilação e bots do Lighthouse

Esperamos continuar esta colaboração em 2021.

Midia​

Dmitry Vinnik (Developer Advocate @ Facebook) explica o Docusaurus em 60 segundos ou em 15min vídeos.

Rachel Nabors (Engenheiro de Documentação @ Facebook) falou um pouco sobre Docusaurus em React Native Radio 178 (podcast), e William Candillon React Native website migration (vídeo).

Muitas postagens foram publicadas:

Comunidade​

A comunidade Docusaurus continua crescendo, o servidor do Discord está bastante ativo e perguntas no Stack Overflow continuam sendo publicadas.

A arquitetura modular do Docusaurus 2 permitiu à comunidade construir e publicar plugins de terceiros. Como gostaríamos de federar melhor nossa comunidade, se você estiver construindo um plugin, nos avise.

O que vem a seguir?​

Como os principais recursos do Docusaurus 2 finalmente foram construídos, seremos capazes de dedicar mais tempo para resolver os pontos de dor e bugs relatados pela comunidade, e tornar o Docusaurus estável e conveniente o suficiente para entrar na versão beta e versões candidatas.

Com suporte adequado para i18n e versionamento, e migrações de grande escala como React Native e Jest, Agora temos um bom caminho de migração para todos os sites do Docusaurus.

Ainda temos algumas principais funcionalidades nas quais gostaríamos de trabalhar:

Muito obrigado à comunidade por suas contribuições em 2020, especialmente:

  • Joel Marcey por criar o Docusaurus e apoiar o projeto o tempo todo
  • a equipe principal - Alexey Pyltsyn, Sébastien Lorber, Yangshun Tay
  • os estagiários da Major League Hacking do Facebook por seu impacto significativo
  • a equipe do Algolia pelo DocSearch 3 e seu apoio
  • Bartosz Kaszubowski por seu investimento na migração do React Native
  • toda a comunidade pelas suas contribuições e oferecendo apoio uns aos outros

Saudações a um ótimo 2021! 🎉