jake

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

Демо

Использование

1. Создать репозиторий

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

1. Нажмите здесь, чтобы создать новый репозиторий.
2. Выберите имя для вашего репозитория. Если вы хотите, чтобы ваш сайт развернулся в <yourusername>.github.io , назовите свой репозиторий <yourusername>.github.io . В качестве альтернативы, вы можете выбрать любое другое имя, такое как that-other-name , которое приведет к тому, что ваш веб-сайт будет развернут по адресу <yourusername>.github.io/that-other-name/ .

2. Включить страницы GitHub

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

1. Перейдите на вкладку Settings вашего хранилища.
2. Перейдите к разделу Pages .
3. Выберите GitHub Actions в качестве источника для ваших страниц GitHub.
4. Нажмите Save , чтобы применить изменения.

3. Добавьте свои данные

Чтобы настроить свой веб -сайт, выполните эти шаги:

1. Откройте свой репозиторий в своем предпочтительном текстовом редакторе.
2. Найдите файл data.toml и обновите его с помощью вашей информации.

Нажмите, чтобы узнать все доступные настройки здесь

Общая информация

• name : Ваше имя (например, "Вахид Ал")
• description : Краткая биография о себе (например, «Разработчик программного обеспечения и увлеченная созданием вещей»)
• keywords : ключевые слова для метага ключевых слов (например, «Python, JavaScript, Go»)
• image : Адрес файла вашего аватара. Поместите свой аватар в папку dist/img/ (например, «me.jpeg» - Обратите внимание, что адрес /dist/img/ адрес не включен)
• theme : Выберите тему вашего сайта: «Темный» или «Свет» (например, «Темный»)
• primary_color : укажите основной цвет вашего веб -сайта, используя шестнадцатеричный цветовой код (например, "#00897b")
• text_align : укажите текстовое выравнивание для вашего веб -сайта: «Право», «Левый» или «Центр» (например, «Центр»)
• gtag_id : ваш идентификатор отслеживания Google Analytics (например, "G-33WB8LVHR6")
• base_url : базовый URL для вашего веб -сайта, упомянутый в 1. Создайте шаг хранилища (например, https://thevahidal.github.io/jake)

Разделы

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

Каждый раздел определяется с использованием [[sections]] и имеет следующие компоненты:

• title : Название раздела (например, «Проекты»)
• description : Краткое описание раздела (например, «Вот некоторые из моих проектов»)
• direction : направление раздела: «ряд» или «столбца» (например, "row")
• item_style : Стиль элементов в разделе: «Схема» или «заполнен» (например, «Окружение»)
• items : пункты, связанные с разделом.

Предметы

Каждый элемент определяется с использованием [[sections.items]] и имеет следующие компоненты:

• title : Название предмета (например, "Soul")
• description : Краткое описание элемента (например, «SQLite Rest и сервер в реальном времени»)
• url : URL, связанный с предметом (например, «https://github.com/thevahidal/soul»)

4. Вуаля

Это все, что вам нужно сделать. Теперь вы можете расслабиться и расслабиться, пока ваш сайт развертывается. Вы можете отслеживать прогресс на вкладке Actions вашего репозитория. Как только развертывание будет завершено, вы можете получить доступ к своему совершенному веб-сайту с одним изготовлением по адресу <yourusername>.github.io (если вы выбрали <yourusername>.github.io в качестве имени репозитория) или <yourusername>.github.io/repo-name/ .

Часто задаваемые вопросы

1. Как настроить свой собственный домен ?

Если вы хотите использовать свой пользовательский домен для вашего веб -сайта, размещенного на страницах GitHub, это простой процесс. Просто следуйте этим шагам:

1. Перейдите на вкладку «Настройки» вашего репозитория GitHub.
2. Выберите вкладку «Страницы» в боковой панели.
3. В разделе «Пользовательский домен» введите желаемое доменное имя.
4. Нажмите Сохранить .

Вот и все! Ваш сайт Github Pages теперь будет доступен с помощью вашего пользовательского домена.

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

2. Как вручную запустить действие GitHub, чтобы развернуть мой сайт?

1. В вашем хранилище перейдите на вкладку «Действия».
2. Ищите рабочий процесс под названием «Развернуть веб -сайт Джейка на страницы GitHub» в списке рабочих процессов.
3. Если вы видите предупреждение, заявив, что «у этого рабочего процесса есть триггер событий Workflow_dispatch», это означает, что вы можете вручную запустить рабочий процесс.
4. Нажмите кнопку «Запустить рабочий процесс». Появится новое окно.
5. В новом окне нажмите кнопку «Запустить рабочий процесс».
6. Действия GitHub инициируют процесс развертывания для вашего статического контента на страницы GitHub.

Внося

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

Лицензия

Этот проект лицензирован по лицензии MIT.