website metalsmith

Фастификация-ваебсит

ПРЕДУПРЕЖДЕНИЕ :
Этот репозиторий был предыдущим домом веб -сайта FASTIFY до июня 2023 года.
Новый дом теперь fastify/website-next

Этот проект используется для построения веб -сайта для фастификации веб -структуры и публикации его в Интернете.

Требования

• Узел 12+
• Установить зависимости с npm install

Строить

Чтобы вызвать сборку сайта, вам просто нужно запустить:

npm run build

Это выполнит все шаги, необходимые для создания сборки (статический веб -сайт).

Если вы развиваете, вы можете запустить:

npm start

Это запустит сборку, а также запустит живой сервер, который позволит вам визуализировать изменения, которые вы вносите на веб -сайте.

(Обратите внимание, что каждый раз, когда вы вносите изменения в активы, которые представляют собой содержание веб -сайта, вам нужно будет запустить npm run build:website чтобы вызвать восстановление)

Построить шаги

Если вы заинтересованы в том, чтобы узнать больше о том, как работает процесс сборки, вот основные шаги, которые выполняются во время его выполнения:

1. Очистка : удаляет временные ресурсы, которые могли бы создать из предыдущей сборки
2. Создание папок Temp : создает необходимые папки для процесса сборки
3. Получить релизы : использует API GitHub для загрузки последних выпусков фазвии, чтобы страницы документации могли быть динамически регенерированы.
4. Выпуски процессов : обрабатывает выбросы, создающие все необходимые динамические файлы, которые производят из исходных выпусков фазвии (в основном используемые для создания и обработки страниц документации)
5. Генерация веб -сайтов : использует металсмит для составления статической версии веб -сайта.

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

Публикация как страницы GitHub

Веб-сайт публикуется автоматически обведите CI с помощью страниц GitHub (Branch gh-pages ).

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

Чтобы это работало, Circle CI должен быть настроен правильно, предоставляя все необходимые переменные среды:

• DOMAIN : пользовательский домен, который будет использоваться на страницах GitHub ( www.fastify.io )
• GH_EMAIL : электронное письмо пользователя GitHub, авторизованное в Circleci, подтолкнуть к филиалу gh-pages
• GH_NAME : Имя пользователя пользователя GitHub, разрешенное в Circleci, подтолкнуть к филиалу gh-pages
• GH_TOKEN : (необязательно) Токен личного доступа GitHub для пользователя, указанного в GH_NAME . Если это присутствует, вызовы API в GitHub будут аутентифицированы.
• CLOUDFLARE_EMAIL : электронная почта учетной записи CloudFlare
• CLOUDFLARE_AUTH_KEY : Ключ авторизации для выполнения вызовов API на API CloudFlare API
• CLOUDFLARE_ZONE : идентификатор зоны CloudFlare, связанного с текущим доменом

Внося

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

Лицензия

Лицензирован по лицензии MIT. © OpenJS Foundation и команда фастификации.