Pular para o conteúdo

Documentação ecológica

As estimativas para o impacto climático da indústria web variam entre 2% e 4% das emissões globais de carbono, aproximadamente o equivalente às emissões da indústria aeronáutica. Há vários fatores complexos no cálculo do impacto ecológico de um website, mas este guia inclui algumas dicas para reduzir a pegada ambiental do seu site de documentação.

A boa noticía é que, escolher o Starlight já é um bom começo! De acordo com o “Website Carbon Calculator”, este site é mais limpo do que 99% das páginas web testadas, produzindo 0.01g de CO₂ por cada visita à página.

Quanto mais dados uma página web transfere mais recursos energéticos são necessários. De acordo com dados do HTTP Archive, em Abril de 2023, uma página web mediana necessitava que o utilizador baixasse mais de 2,000 KB.

O Starlight constrói páginas que são o mais leve possível. Por exemplo, na primeira visita, um utilizador vai descarregar menos do que 50 KB de dados comprimidos, ou seja, apenas 2.5% da mediana indicada pelo HTTP Archive. Com uma boa estratégia de cache, as navegações subsequentes podem descarregar tão pouco quanto 10 KB.

Enquanto o Starlight providencia uma boa base, as imagens que você adicionar à sua documentação podem aumentar o peso da sua página rapidamente. O Starlight usa o suporte a assets otimizados do Astro para otimizar imagens locais nos seus arquivos Markdown e MDX.

Os componentes construídos com frameworks de UI como React ou Vue podem facilmente adicionar grandes quantidades de JavaScript a uma página. Porque o Starlight é construído com o Astro, e graças às Ilhas Astro, esses componentes carregam, por padrão, zero código JavaScript no lado do cliente.

A Cache é usada para controlar por quanto tempo um navegador armazena e reutiliza os dados já descarregados. Uma boa estratégia de caching garante que um utilizador receba o conteúdo novo o mais cedo possível assim que ele muda, mas também evita descarregar inutil e repetidamente o mesmo conteúdo sem que ele mude.

A forma mais comum de configurar a cache é com o header HTTP Cache-Control. Ao utilizar o Starlight, você pode definir um grande tempo de cache para todo o conteúdo do diretório /_astro/. Este diretório contém CSS, JavaScript e outros artefactos em bundle que podem ser seguramente cached para sempre, reduzindo assim downloads desnecessários:

Cache-Control: public, max-age=604800, immutable

A forma de configurar a cache depende do seu alojamento web. Por exemplo, o Vercel aplica por você esta estratégia de cache sem necessidade de configuração adicional, já a definição de cabeçalhos customizados para Netlify necessita que adicione um arquivo public/_headers ao seu projeto:

/_astro/*
Cache-Control: public
Cache-Control: max-age=604800
Cache-Control: immutable

A forma com que uma página web é construída pode ter impacto na energia necessária para executá-la no dispositivo de um utilizador. Por utilizar JavaScript ao mínimo, o Starlight reduz a quantidade de energia de processamento que o celular, tablet ou computador de um utilizador precisa para carregar e renderizar páginas.

Tenha atenção ao adicionar funcionalidades como scripts de rastreamento de Analytics ou conteúdo cheio de JavaScript como embeds de vídeo já que estes podem aumentar o consumo de energia da página. Se você precisa de Analytics, considere escolher uma opção leve como Cabin, Fathom ou Plausible. Embeds como vídeos do YouTube e Vimeo podem ser melhorados se carregar o vídeo mediante a interação do usuário. Pacotes como o astro-embed podem ajudá-lo com alguns dos serviços comuns.

O lugar onde uma página web é alojada pode ter um grande impacto no quão amigável ao ambiente o seu site de documentação é. Os centros de dados e de servidores podem ter um grande impacto ecológico, incluindo alto consumo de eletricidade e uso intensivo de água.

Escolher um alojamento que utiliza energia renovável significará menos emissões de carbono para o seu site. A Green Web Directory é uma ferramenta que poderá ajudá-lo a encontrar empresas de alojamento.

Está curioso para comparar com os outros frameworks de documentação? Estes testes realizados com o Website Carbon Calculator comparam páginas semelhantes construídas com diferentes ferramentas.

FrameworkCO₂ per page visitRating
Starlight0.01gA+
Read the Docs0.05gA+
Sphinx0.06gA+
VitePress0.07gA+
Docus0.09gA+
docsify0.10gA
Nextra0.11gA
MkDocs0.19gB
Docusaurus0.21gB
GitBook0.43gC
Mintlify1.22gF

Dados recolhidos a 22 de Julho de 2024. Clique num dos links para ver os valores atualizados.