Скачать seagl.github.io - seagl.github.io Загрузка исходного кода

seagl.github.io

Другие категории

1.0.0

Скачать

СиГЛ

Это исходный код веб-сайта https://seagl.org.

Он использует Jekyll в качестве генератора статических сайтов с GitHub Pages.

Сайт автоматически отображается каждый раз, когда код отправляется в общий репозиторий на GitHub.

По сути, шаги по обновлению сайта (например, для публикации нового сообщения в блоге):

Форкнуть/клонировать репозиторий,
Внесите свои изменения,
Проверьте свои изменения,
Отправьте запрос на внесение изменений (PR) на изменения,
Как только PR будет объединен, ваши изменения будут опубликованы в реальном времени.

Ниже приведены инструкции для каждого из этих шагов. В инструкциях предполагается, что работу выполняет кто-то с меньшим опытом работы с git/GitHub/техническим опытом. Те, у кого больше опыта, могут экстраполировать соответствующие выводы. :-)

Форкнуть/клонировать репозиторий

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

Чтобы разветвить репозиторий:

Нажмите «Вилка» вверху страницы.
Выберите целевой аккаунт/организацию для копии репо.
Подождите, пока все будет скопировано.

Вуаля! Вот и все.

Внесите изменения

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

Поместите все сообщения блога в каталог _posts .
Имя файла начинается с даты в формате YYYY-MM-DD . Это очень важно , поскольку оно контролирует порядок, в котором на веб-сайте отображаются сообщения блога.
- ПРИМЕЧАНИЕ : На веб-сайте будут отображаться сообщения, датированные текущей датой включительно. Это позволяет вам планировать публикации заранее, но это также означает, что публикации, датированные будущим, не появятся, если вы не используете --future при тестировании ваших изменений. На данный момент также необходимо запустить перестройку сайта в запланированную дату или после нее, чтобы публикация появилась. Это можно сделать с помощью: git commit -m 'rebuild pages' --allow-empty && git push origin main или внеся какие-либо фактические изменения на сайт.
За датой следует поставить тире ( - ), а затем заголовок сообщения, разделенный тире. Этот заголовок не отображается. Это просто имя файла. Пожалуйста, сделайте это кратко, но описательно.
Используйте расширение имени файла .md , чтобы обозначить, что сообщение составлено в формате Markdown. (и, пожалуйста, пишите сообщения только с использованием Markdown)

Согласно этим правилам, сообщение в блоге, объявляющее об открытии CFP 2017, может иметь имя файла:

 2017-06-19-CFP-open.md

Также добавьте следующее в начало файла:

 ---
layout: post
title: 'Example Title'
status: publish
type: post
published: true
categories: news
tags: '2013'
---

Установите title в качестве заголовка вашего сообщения в блоге и отредактируйте tags , включив в него год конференции, с которым связано сообщение (пусто, если его нет). Пожалуйста, оставьте остальные значения как есть.

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

На GitHub

Перейдите в каталог, в котором находится файл, который вы хотите отредактировать или добавить (вероятно, _posts ).
Чтобы создать новый файл:
- Нажмите Create a new file
- Назовите свой файл (согласно инструкциям выше, если это сообщение в блоге).
Внесите изменения
- Чтобы создать новый файл:
  - Нажмите Create a new file
  - Введите имя файла (согласно инструкции выше, если это сообщение в блоге)
- Чтобы отредактировать существующий файл:
  - Нажмите на файл, чтобы выбрать его
  - Нажмите на маленький значок карандаша
- В любом случае теперь вы можете редактировать файл в веб-интерфейсе.
Зафиксируйте изменения, используя форму Commit changes под интерфейсом редактирования.
- Введите краткий, но информативный заголовок, например «Добавление объявления об открытии CFP 2017».
- Введите подробное описание. Если вы работаете над проблемой, укажите здесь номер проблемы. Используйте решетку ( # ), за которой следует номер проблемы ( #74 ). Это будет автоматически связано с запросом на включение, что очень удобно.

На вашей локальной машине

TBD (предполагается, что те, кто использует git на своих локальных машинах, уже знают это; заполним позже)

клонируйте свою вилку
внесите изменения (добавьте и/или отредактируйте файлы)
зафиксируйте изменения обратно в свою вилку

Проверьте свои изменения

Пожалуйста, протестируйте все изменения локально, прежде чем отправлять их на GitHub.

Локальный сервер разработки

Запуск локального сервера разработки сделает вашу копию сайта доступной по адресу http://localhost:4000. Есть несколько способов запустить сервер. Выбирайте!

Вариант 1: Голый металл

Зависимости:

Руби
Бандлер

Одноразовая установка:

bundle install

Запустите сервер:

bundle exec jekyll serve --watch

Чтобы просмотреть будущие и неопубликованные публикации, добавьте --future --unpublished к приведенной выше команде.

Вариант 2: Контейнерный

Зависимости:

Docker (или Podman; замените docker на podman )

Единоразовая установка:

docker build --tag ' seagldev ' ' . '

Запустите сервер:

docker run --rm --interactive --tty --publish ' 4000:4000 ' --volume " $PWD :/usr/src/app " ' seagldev '

Чтобы просмотреть будущие и неопубликованные публикации, добавьте --future --unpublished в конце приведенной выше команды.

Отправьте запрос на внесение изменений (PR)

Вы можете отправить PR через интерфейс GitHub или со своего локального компьютера.

На GitHub

В браузере перейдите к ответвлению репозитория seagl.github.io.
Нажмите на вкладку Pull requests .
Нажмите New pull request button .
GitHub распознает, что ваш репозиторий является форком, и по умолчанию PR является основной ветвью вашего форка, запрашивающей основную ветвь seagl.github.io. Шансы очень хорошие, это то, что вам нужно. Если это не так, вы будете знать достаточно, чтобы осознать это. :-)
Нажмите Create pull request .
Введите краткий, но информативный заголовок, например «Добавление объявления об открытии CFP 2017».
Введите подробное описание. Если вы работаете над проблемой, укажите здесь номер проблемы. Используйте решетку ( # ), за которой следует номер проблемы ( #74 ). Это будет автоматически связано с запросом на включение, что очень удобно.
Выберите [Allow edits from maintainers](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) , чтобы другие члены команды могли при необходимости вносить изменения.
Нажмите Create pull request .

На вашей локальной машине

TBD (предполагается, что те, кто использует git на своих локальных машинах, уже знают это; заполним позже)

Ваши изменения будут опубликованы в прямом эфире

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

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

ПРИМЕЧАНИЕ . Само по себе слияние не приведет к перестройке сайта. Чтобы перестроить сайт, вам нужно отправить пустой коммит следующим образом:

git commit --allow-empty -m " Rebuild the site, please " && git push

Как добавлять изображения в сообщения

Добавьте свое изображение в каталог img/posts/ , затем используйте следующий Markdown:

 ![ Example description ] ( /img/posts/example.jpg )

Советы:

Чтобы выровнять изображение по бокам, добавьте класс align-left или align-right :
```
 ![ Example description ] ( /img/posts/example.jpg ) {:.align-left}
```
Чтобы сократить время загрузки страницы, измените размер изображений до разумного размера, прежде чем использовать их в публикации.