Документация UGENE

В этом репозитории находится сайт документации UGENE, построенный на Hugo с темой Docsy.

Требования

• Node.js (версия 18 или новее) с npm — Скачать
• Hugo Extended версии 0.145.0 — Скачать. Тема Docsy требует именно Extended-версию (с поддержкой Sass/SCSS), обычная версия Hugo не подойдёт.

Установка

1. Установка Hugo Extended

Выберите вашу операционную систему:

Linux

# Скачать нужную версию (0.145.0)
wget https://github.com/gohugoio/hugo/releases/download/v0.145.0/hugo_extended_0.145.0_linux-amd64.tar.gz

# Распаковать и установить
tar -xzf hugo_extended_0.145.0_linux-amd64.tar.gz
sudo mv hugo /usr/local/bin/

# Проверить установку
hugo version

Windows

1. Скачайте hugo_extended_0.145.0_windows-amd64.zip со страницы релизов.
2. Распакуйте архив в любую папку, например C:\hugo.
3. Добавьте эту папку в системную переменную PATH:
   • Откройте Параметры системы → Переменные среды.
   • В разделе Системные переменные найдите переменную Path и нажмите Изменить.
   • Нажмите Создать и добавьте путь к папке с Hugo (например, C:\hugo).
   • Нажмите ОК во всех окнах.
4. Откройте новый терминал и проверьте установку:

   hugo version

Важно: Тема Docsy требует Extended версию Hugo.

2. Установка зависимостей Node.js

npm install

Запуск сервера разработки

Запустите локальный сервер разработки с автоперезагрузкой при изменениях:

npm run dev

Сайт будет доступен по адресу http://localhost:1313.

Другие команды

Команда	Описание
npm run dev	Запуск сервера разработки
npm run dev-theme	Сервер разработки с отслеживанием темы (без быстрой перезагрузки)
npm run prod	Сборка production-версии в папку public/

Редактирование с автообновлением в браузере

После запуска сервера разработки (npm run dev) вы можете редактировать файлы в папке content/, и браузер будет автоматически обновляться, отображая изменения.

Например:

• Откройте content/_index.md в текстовом редакторе.
• Внесите изменения и сохраните файл.
• Переключитесь в браузер — страница обновится сама, без перезагрузки вручную.

Подробнее о разработке сайтов на Hugo: https://gohugo.io/documentation/

Файлы перенаправления из UGENE

В папке static/ugene-help-page/ находятся HTML-файлы вида 16122696.html. Когда пользователь открывает справку по какой-либо функции в программе UGENE, она переходит по ID на соответствующий HTML-файл, который перенаправляет браузер на правильную страницу документации на сайте.

Сборка для продакшна

Локально собирать продакшн необязательно — это нужно только для проверки. При коммите в Git сборка происходит автоматически, и сайт обновляется в течение нескольких минут.

Если всё же нужно собрать вручную:

npm run prod

Результат будет в папке public/.