Развертывание сайта

Как указывалось ранее, развертывание сайта в интернете на платформе GitHub требует создания отдельного репозитория, относительно которого будет развернут сайт.

При создании репозитория могут быть два варианта:

Предполагается, что сайт будет только один и расположен по родительскому адресу
Базовый сайт уже существует, но требуется еще один сайт (дочерний сайт)

Важным для любого из вариантов является наличие репозитория с предопределенным именем: имя_аккаунта.github.io. Это имя фактически является частью интернет адреса, по которому будет расположен сайт или сайты.
Для нашего примера MyGit.github.io.

Эту схему можно представить, как список адресов сайтов:

https://mygit.github.io/ - родительский сайт
https://mygit.github.io/site 1/ - дочерний сайт 1
https://mygit.github.io/site N/ - дочерний сайт N

Таким образом сайтов можно создать много.
Каждый созданный сайт - это свой репозиторий и доступ к нему может быть отрегулирован, как Public или Private.

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

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

При этом содержание файла index.html можно сделать, например:

пустая страница <html></html>.

Создание репозитория для развертывания сайта

Создаем репозиторий

Рис. 2 - Создание и настройки репозитория на GitHub

1. Имя репозитория (Repository name):
- родительский сайт - mygit.github.io
- дочерний сайт - например, smydocs
2. Описание репозитория, например: Сайт ...
3. Выбираем, какой будет репозиторий:
- Public - доступный всем для просмотра.
- Private - доступный тем, кто имеет разрешения.
4. Обязательно ставим галку "Add a README file" для инициализации репозитория

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

Рис. 3 - Меню на странице аккаунта GitHub

На открывшейся странице

Рис. 4 - Настройка GitHub Pages

1. Выбираем пункт Pages
2. Выбираем main
3. Нажимаем кнопку Save (сохранить)

Настройка конфигурационного файла

Создав репозиторий на стороне GitHub мы обеспечили место размещение сайта, но сам установленный на ПК Docusaurus ни чего не "знает" ни о каких репозиториях. Поэтому, необходимо провести настройку конфигурационного файла docusaurus.config.js, который лежит в корне проекта изменением некоторых свойств.

Свойства	Родительский сайт	Дочерний сайт	Примечание
title	'Docusaurus'	'Docusaurus'	Это часть заголовка окна браузера, любое значение
tagline	'docusaurus help'	'docusaurus help'	любое значение краткая информация о сайте, слоган
baseUrl	'/'	'/smydocs/'	всегда - для родительского сайта / - для дочернего сайта это /имя репозитория/
url	'`https://mygit.github.io`'	'`https://mygit.github.io`'	родительский URL
organizationName	'mygit'	'mygit'	имя аккаунта
projectName	'mygit.github.io'	'smydocs'	имя репозитория - для родительского сайта часть URL - для дочернего сайта имя репозитория