Publii включает поддержку Github Pages, которые предоставляют вам пространство для создания веб-сайта, который вы можете использовать для освещения ваших проектов на Github или просто для себя! К сожалению, функционал для реального создания веб-сайта невелик, если у вас нет каких-либо ноу-хау и вы не готовы освоить сложные в настройке инструменты, такие как Jekyll, но благодаря Publii вы сможете всего за несколько минут создать полнофункциональный, потрясающий веб-сайт, который очень легко обновлять и обслуживать.

Создание страницы на Github не займет много времени, но нам нужно будет выполнить несколько шагов, начиная с:

Генерация токена доступа

Прежде чем мы сможем приступить к созданию страницы Github, нам нужно сгенерировать токен доступа; это позволит Publii получать доступ и вносить изменения к вашей странице Github, чтобы он мог создавать и редактировать ваш веб-сайт всякий раз, когда вы нажимаете кнопку Синхронизировать в приложении Publii; думайте об этом как о создании пароля, который Publii может использовать для входа в Github club!

Создание токена доступа занимает всего несколько секунд; просто выполните следующие действия:

1. Для начала перейдите на главную страницу Github и войдите в свою учетную запись; если у вас еще нет учетной записи, просто нажмите на ссылку Зарегистрироваться и завершите процесс регистрации. 

   

2. После входа в систему откройте настройки своего профиля на Github. 

   

3. В левой боковой панели экрана вашего профиля нажмите на Настройки разработчика. 

   

4. На странице приложений GitHub в левой боковой панели нажмите на опцию Токены личного доступа и выберите опцию Токены (классические). 

   

5. Теперь мы находимся на странице персональных токенов доступа; нам нужно создать новый для нашего сайта, поэтому нажмите на кнопку "Сгенерировать новый токен" в верхней части экрана и выберите опцию "Сгенерировать новый токен (классический)". 

   

6. На следующем экране введите имя в разделе "Примечание", например, "Публичная страница GitHub". Теперь в разделе Выбор областей добавьте галочку к опции main Repo, которая предоставит токену доступ ко всем аспектам управления вашим репозиторием. Вы также можете установить дату истечения срока действия вашего токена, например, "90 дней", чтобы обеспечить безопасность вашей информации. Наконец, нажмите зеленую кнопку Сгенерировать токен в нижней части экрана. 

   

7. Теперь вы вернетесь на страницу Персональных токенов доступа, но теперь ваш новый токен будет виден вверху списка. Что бы вы ни делали, не закрывайте и не обновляйте эту страницу; токен будет виден только сразу после создания. Нажмите на значок Копировать рядом с вашим токеном (см. Изображение ниже) и скопируйте его в безопасное место, поскольку он нам понадобится при настройке Publii для работы с нашей страницей на Github. 

   

   Помните: вы не сможете снова увидеть токен, поэтому убедитесь, что он где-то сохранен.

Теперь у нас есть сгенерированный токен, поэтому мы можем создать наш веб-сайт в Publii и предоставить ему доступ к нашей странице на Github.

Создание нашего статического веб-сайта на страницах Github

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

1. Войдите в Github как обычно, затем щелкните значок плюса на верхней панели, чтобы открыть подменю; теперь нажмите на опцию "Новый репозиторий", чтобы перейти на экран "Создать новый репозиторий". 

   

2. На этом экране введите имя репозитория и оставьте репозиторий как общедоступный (страницы Github всегда являются общедоступными, даже когда репозиторий, в котором они размещены, становится частным). Далее нажмите зеленую кнопку Создать репозиторий в нижней части экрана. 

   

3. Теперь мы находимся на экране Быстрой настройки; это может показаться немного запутанным, но здесь нам нужно сделать только одну простую вещь. Нажмите на ссылку README, как показано на рисунке ниже; это приведет нас к экрану создания файла readme. 

   

4. На экране редактирования readme просто нажмите кнопку Зафиксировать новый файл. Мы создаем этот файл только потому, что в ваш репозиторий необходимо добавить хотя бы один элемент для создания вашей основной ветки, куда будут помещены все ваши файлы Publii. Этот созданный файл будет автоматически удален при первой синхронизации Publii с нашей страницей на Github. 

   

5. После фиксации файла мы возвращаемся к списку файлов; нажмите на вкладку "Настройки" в верхней части экрана. 

   

6. На экране настройки, в левой боковой панели, нажмите на страницах; в сборки и развертывания разделе, в частности, в филиал разделе, щелкните на выпадающий список, по умолчанию отображает ничего, и выбрать главную ветку из списка параметров. Теперь нажмите кнопку Сохранить, чтобы убедиться, что изменения зафиксированы. 

   

7. После сохранения ваши страницы GitHub будут готовы к использованию в качестве статического хостинга веб-сайта; для просмотра вашего веб-сайта вам нужно будет перейти по URL, указанному в окне сообщения. Иногда вам может потребоваться обновить страницу, которую вы просматриваете в данный момент, чтобы увидеть поле URL. Конечно, на вашем сайте пока нет файлов, но мы собираемся это изменить. 

   

И это все, что касается Github; теперь мы можем перейти к Publii для последнего шага.

Синхронизация вашего статического сайта Publii с Github

Поскольку все подготовлено на Github, мы можем обновить настройки подключения в Publii для синхронизации с репозиторием страниц Github, который мы только что создали. Сначала откройте Publii; если вы еще не создали свой веб-сайт, создайте его и добавьте хотя бы одно сообщение и убедитесь, что вы выбрали тему; без них ваш сайт не будет создан должным образом.

Теперь нажмите на опцию Сервер в левой боковой панели, чтобы открыть экран Настройки сервера. Заполните поля следующей информацией:

• URL веб-сайта - это будет путь к вашему репозиторию на Github, который использует формат "YOUR_USERNAME.github.io / YOUR_REPOSITORY_NAME".
• Сервер API - По умолчанию это поле уже заполнено на стандартном сервере API. Однако, если вы используете свой собственный экземпляр GitHub, вы можете изменить сервер API, введя его здесь.
• Имя пользователя - Добавьте сюда свое имя пользователя на Github.
• Репозиторий - Введите здесь название вашего репозитория Github (мы установили это на шаге 2 раздела Страницы Github выше).
• Ветка - Если вы следовали нашему руководству, то напишите main (с учетом регистра) в текстовом поле; опытные пользователи могут захотеть указать другие настройки, такие как gh-страницы, документы и т.д...
• Токен - Помните токен доступа, который мы сохранили в первой части этого руководства? Введите его здесь, чтобы пользователи могли получить доступ к репозиторию.
• Параллельные загрузки - по умолчанию равно '1'. Задает количество потоков загрузки, которые Publii может использовать при загрузке содержимого вашего сайта на страницы GitHub. Более высокие значения позволяют ускорить загрузку, но могут вызывать ошибки при медленных соединениях или ошибку 403 из-за ограничений скорости загрузки API.
•  Ограничение скорости API - Отключите эту опцию, только если вы используете Github Enterprise с отключенным ограничением скорости API. В противном случае отключение этой опции может привести к ошибкам развертывания.

После того, как все параметры будут установлены, нажмите на кнопку Сохранить настройки, чтобы сохранить внесенные изменения. Возможно, сейчас самое подходящее время нажать кнопку Проверить подключение, которая проверит, может ли Publii подключиться к вашей странице на Github; если нет, то, возможно, некоторые поля были введены неправильно.

Теперь все готово, поэтому мы можем нажать кнопку Синхронизировать ваш веб-сайт на боковой панели Publii, чтобы начать развертывание.

ВАЖНО! Загруженный вами сайт Publii может быть виден не сразу после завершения процесса синхронизации; это может занять около. 1 минута, прежде чем вы увидите изменения на своем сайте. Если вы хотите перепроверить, были ли применены ваши изменения, вы можете проверить раздел Commits вашего репозитория и проверить значок рядом с вашим последним коммитом в области фиксации:

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

Ограничения

Реализация поддержки Github Pages в Publii имеет два ограничения на текущей итерации:

• Невозможно загрузить веб-сайт с более чем 1000 файлами, хотя в более поздних версиях это количество будет увеличено примерно до 5000 файлов. Это ограничение достаточно велико для подавляющего большинства веб-сайтов, но полезно помнить об этом на случай, если вы запускаете очень крупный веб-проект через Publii.
• API Github ограничен 5000 запросами в час; Publii сообщит вам, если лимит запросов окажется слишком низким для завершения развертывания или синхронизации вашего веб-сайта. Это ограничение также применяется, если синхронизация содержит более 5000 изменений одновременно; в этом случае вам следует регулярно синхронизировать свой веб-сайт, чтобы избежать накопления слишком большого количества изменений.

Несколько полезных советов и хитростей

Хотите получить немного больше контроля над своим сайтом? Вот несколько полезных приемов, которые помогут вашему сайту получить именно то, что вы хотите:

Упростите URL вашего сайта до yourusername.github.io

По умолчанию URL вашей страницы на Github будет username.github.io/repository-name, но мы можем упростить это, создав репозиторий для нашего веб-сайта под названием yourusername.github.io например, если мое имя пользователя - TestName, я бы создал репозиторий под названием TestName.github.io.

Затем, вместо дублирования URL как TestName.github.io/TestName, Github упростит URL только до TestName.github.io.

Использование пользовательского домена

Если вы предпочитаете использовать свое собственное доменное имя, а не поддомен github.io, Publii автоматически создаст файл CNAME с вашим пользовательским доменным именем, которое ищут страницы Github.

Перед выполнением этого вам нужно настроить свой домен, используя третий шаг из этого руководства по пользовательскому домену от Github; если вам нужна дополнительная помощь, советы, включенные в эту статью по настройке домена, помогут.

Доступен ли SSL для вашего пользовательского домена?

На всех поддоменах github.io по умолчанию включен SSL, также HTTPS поддерживается для страниц Github, у которых есть пользовательские домены.

Используйте разные ветки в своем репозитории

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

ВАЖНО! Если вы используете ветку, отличную от master, для вашего веб-сайта Github Page, убедитесь, что вы изменили название ветки в настройках Publii; если вы оставите это как "master", а затем синхронизируете свой веб-сайт Publii, удалите все существующие файлы из вашей master-ветки!

Скачать Publii