Начало работы
Быстрый старт с шаблона
imfing/hextra-starter-template
Вы можете быстро начать, используя указанный выше шаблонный репозиторий.
Мы предоставили рабочий процесс GitHub Actions, который может автоматически собирать и развертывать ваш сайт на GitHub Pages совершенно бесплатно. Больше вариантов смотрите в разделе Развертывание сайта.
Создание нового проекта
Есть два основных способа добавить тему Hextra в ваш проект Hugo:
-
Модули Hugo (рекомендуется): Самый простой и рекомендуемый метод. Модули Hugo позволяют подключить тему напрямую из её исходного кода. Тема загружается автоматически и управляется Hugo.
-
Подмодуль Git: Альтернативный способ — добавить Hextra как Подмодуль Git. Тема загружается через Git и хранится в папке
themesвашего проекта.
Настройка Hextra как модуля Hugo
Предварительные требования
Перед началом убедитесь, что у вас установлено следующее программное обеспечение:
Шаги
Инициализация нового сайта Hugo
hugo new site my-site --format=yamlНастройка темы Hextra через модуль
# инициализация модуля Hugo
cd my-site
hugo mod init github.com/username/my-site
# добавление темы Hextra
hugo mod get github.com/imfing/hextraНастройте hugo.yaml для использования темы Hextra, добавив следующее:
module:
imports:
- path: github.com/imfing/hextraСоздание первых страниц контента
Создайте новые страницы для главной страницы и документации:
hugo new content/_index.md
hugo new content/docs/_index.mdПредпросмотр сайта локально
hugo server --buildDrafts --disableFastRenderГотово! Ваш новый сайт доступен для предпросмотра по адресу http://localhost:1313/.
Как обновить тему?
Чтобы обновить все модули Hugo в вашем проекте до последних версий, выполните команду:
hugo mod get -uЧтобы обновить Hextra до последней выпущенной версии, выполните команду:
hugo mod get -u github.com/imfing/hextraЕсли вы хотите попробовать последние изменения до следующего релиза, обновите модуль до ветки разработки напрямую (⚠️ может содержать нестабильные/критические изменения):
hugo mod get -u github.com/imfing/hextra@mainПодробнее см. в Модулях Hugo.
Настройка Hextra как подмодуля Git
Предварительные требования
Перед началом убедитесь, что у вас установлено следующее программное обеспечение:
Шаги
Инициализация нового сайта Hugo
hugo new site my-site --format=yamlДобавление темы Hextra как подмодуля Git
Перейдите в директорию сайта и инициализируйте новый репозиторий Git:
cd my-site
git initЗатем добавьте тему Hextra как подмодуль Git:
git submodule add https://github.com/imfing/hextra.git themes/hextraНастройте hugo.yaml для использования темы Hextra, добавив следующее:
theme: hextraСоздание первых страниц контента
Создайте новые страницы для главной страницы и документации:
hugo new content/_index.md
hugo new content/docs/_index.mdПредпросмотр сайта локально
hugo server --buildDrafts --disableFastRenderВаш новый сайт доступен для предпросмотра по адресу http://localhost:1313/.
При использовании CI/CD для развертывания сайта Hugo важно убедиться, что следующая команда выполняется перед запуском команды hugo.
git submodule update --initЕсли не выполнить эту команду, папка темы не будет заполнена файлами темы Hextra, что приведет к сбою сборки.
Как обновить тему?
Чтобы обновить все подмодули в вашем репозитории до последних коммитов, выполните команду:
git submodule update --remoteЧтобы обновить Hextra до последнего коммита, выполните команду:
git submodule update --remote themes/hextraПодробнее см. в Подмодулях Git.
Далее
Изучите следующие разделы, чтобы начать добавлять больше контента: