Экологичная документация

Оценки влияния интернет-индустрии на климат варьируются от 2% до 4% глобальных выбросов углерода, что близко к выбросам авиационной индустрии. Расчет экологического воздействия веб-сайта включает в себя множество сложных факторов, но в данном руководстве перечислены несколько советов по снижению экологического следа вашего сайта с документацией.

Хорошая новость в том, что выбор Starlight — отличное начало. Согласно Website Carbon Calculator, этот сайт чище, чем 99% протестированных веб-страниц, производя 0,01 г CO₂ за каждое посещение страницы.

Вес страницы

Чем больше данных передает веб-страница, тем больше энергетических ресурсов она требует. В апреле 2023 года, медианная веб-страница требовала от пользователя скачать более 2 000 КБ данных, согласно данным из HTTP Archive.

Starlight создает страницы лёгкими, настолько, насколько это возможно Например, при первом посещении пользователь загрузит менее 50 КБ сжатых данных, что составляет всего 2,5% от медианного значения HTTP архива. При хорошей стратегии кэширования последующие навигации могут загружать всего 10 КБ.

Изображения

Хоть Starlight и предлагает лёгкие страницы по умолчанию, изображения, которые вы добавляете на страницы документации, могут быстро увеличивать вес вашей страницы. Starlight использует оптимизировацию ресурсов Astro для оптимизации локальных изображений в ваших файлах Markdown и MDX.

UI-компоненты

Компоненты, на UI-фреймворках, как React или Vue, могут легко добавлять большие объемы JavaScript на страницу. Поскольку Starlight основан на Astro, эти компоненты по умолчанию не загружают клиентский JavaScript благодаря Островам Astro.

Кэширование

Кэширование управляет тем, как долго браузер хранит и повторно использует данные, которые он уже загрузил. Хорошая стратегия кэширования гарантирует, что пользователь получает новое содержание как можно быстрее, когда оно меняется, но также избегает бесполезной повторной загрузки одного и того же содержания снова и снова, когда оно не изменилось.

Самым распространённым способом настройки кэширования является использование HTTP-заголовка Cache-Control. При использовании Starlight вы можете установить длительное время кэширования для всего, что находится в каталоге /_astro/. Этот каталог содержит CSS, JavaScript и другие ресурсы, которые можно безопасно кэшировать навсегда, что позволяет снизить избыточные загрузки:

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

Как настроить кэширование зависит от вашего веб-хоста. Например, Vercel автоматически применяет эту стратегию кэширования без необходимости настройки, в то же время вы можете установить заголовки для Netlify, добавив файл public/_headers в ваш проект:

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

Потребление энергии

То, как реализована веб-страница может влиять на потребление энергии при её запуске на устройстве пользователя. За счет минимального использования JavaScript, Starlight снижает объем вычислительных ресурсов, необходимых телефону, планшету или компьютеру пользователя для загрузки и отображения страниц.

Будьте внимательны при добавлении функций, таких как скрипты отслеживания аналитики или контент, зависящий от JavaScript, например, встроенные видео, так как они могут увеличить энергопотребление страницы. Если вам необходима аналитика, рассмотрите выбор легковесного варианта, такого как Cabin, Fathom или Plausible. Встроенные видео, такие как YouTube и Vimeo, можно улучшить, ожидая взаимодействие пользователя для загрузки видео. Пакеты, такие как astro-embed, могут помочь с часто используемыми сервисами.

Хостинг

Место, где размещена веб-страница, может иметь большое влияние на то, насколько экологичен ваш сайт с документацией. Дата-центры и серверные фермы могут оказывать значительное экологическое воздействие, включая высокий энергопотребление и интенсивное использование воды.

Выбор хостинга, использующего возобновляемую энергию, снизит выбросы углерода для вашего сайта. Справочник Green Web — один из инструментов, который может помочь вам найти хостинговые компании, работающие с экологически чистой энергией.

Сравнения

Хотите сравнивить другие фреймворки для документации? Эти тесты с использованием Website Carbon Calculator сравнивают аналогичные страницы, созданные с помощью разных инструментов.

Фреймворк	CO₂ на каждое посещение стр.	Рейтинг
Starlight	0.01g	A+
Read the Docs	0.05g	A+
Sphinx	0.06g	A+
VitePress	0.07g	A+
Docus	0.09g	A+
docsify	0.10g	A
Nextra	0.11g	A
MkDocs	0.19g	B
Docusaurus	0.21g	B
GitBook	0.43g	C
Mintlify	1.22g	F

Данные собраны 22 июля 2024 года. Нажмите на ссылку для просмотра актуальной информации.

Дополнительные ресурсы

Инструменты

Статьи и выступления

Построение более экологичного веба, выступление Мишель Баркер
Стратегии устойчивого веб-развития в организации, статья Мишель Баркер
Экологически устойчивый веб для каждого, выступление Тома Гринвуда
Как веб-контент может влиять на энергопотребление, статья Бенджамина Пулена и Саймона Фрейзера.