seagl.github.io herunterladen - seagl.github.io Quellcode herunterladen

seagl.github.io

Andere Kategorien

1.0.0

Herunterladen

SeaGL

Dies ist der Quellcode für eine Website unter https://seagl.org.

Es verwendet Jekyll als statischen Site-Generator mit GitHub Pages.

Die Site wird automatisch gerendert, wenn Code in das gemeinsame Repository bei GitHub übertragen wird.

Im Wesentlichen sind die Schritte zum Aktualisieren der Website (z. B. zum Veröffentlichen eines neuen Blog-Beitrags) wie folgt:

Forken/Klonen des Repositorys,
Nehmen Sie Ihre Änderungen vor,
Testen Sie Ihre Änderungen,
Senden Sie eine Pull-Anfrage (PR) für die Änderungen.
Sobald die PR zusammengeführt ist, werden Ihre Änderungen live veröffentlicht

Nachfolgend finden Sie Anweisungen für jeden dieser Schritte. Die Anweisungen gehen davon aus, dass jemand mit weniger Git-/GitHub-/technischer Erfahrung die Arbeit ausführt. Wer mehr Erfahrung hat, kann entsprechend hochrechnen. :-)

Verzweigen/klonen Sie das Repository

Während Sie wahrscheinlich direkt an diesem Repository arbeiten können , ist dies bei Best Practices nicht der Fall. Stattdessen können Sie das Repo forken oder klonen und dann Ihre Änderungen an dieser Kopie vornehmen. Dies ermöglicht Tests, bevor Änderungen live vorgenommen werden, und verringert das Risiko, dass eine schlecht formatierte oder formulierte Änderung an die Öffentlichkeit gelangt.

So forken Sie das Repository:

Klicken Sie oben auf der Seite auf die Gabel.
Wählen Sie das Zielkonto/die Zielorganisation für die Kopie des Repos aus.
Warten Sie, bis alles kopiert wurde.

Voila! Das ist alles.

Nehmen Sie Ihre Änderungen vor

Wenn Sie einen neuen Blog-Beitrag hinzufügen, befolgen Sie bitte diese Regeln für Dateinamen:

Platzieren Sie alle Blogbeiträge im Verzeichnis _posts .
Beginnen Sie den Dateinamen mit einem Datum im Format YYYY-MM-DD . Dies ist sehr wichtig , da es die Reihenfolge steuert, in der die Website Blogbeiträge anzeigt.
- HINWEIS : Auf der Website werden Beiträge angezeigt, die bis einschließlich zum aktuellen Datum datiert sind. Dadurch können Sie Beiträge im Voraus planen, aber es bedeutet auch, dass Beiträge mit Datum in der Zukunft nicht angezeigt werden, es sei denn, Sie verwenden --future beim Testen Ihrer Änderungen. Derzeit ist es außerdem erforderlich, dass Sie am oder nach dem geplanten Datum einen Neuaufbau der Website auslösen, damit der Beitrag erscheint. Dies kann mit: git commit -m 'rebuild pages' --allow-empty && git push origin main oder durch tatsächliche Änderungen an der Site erfolgen.
Fügen Sie dem Datum einen Bindestrich ( - ) und dann einen durch Bindestriche getrennten Titel für den Beitrag hinzu. Dieser Titel wird nicht angezeigt. Es geht nur darum, die Datei zu benennen. Bitte machen Sie es kurz, aber beschreibend.
Verwenden Sie die Dateinamenerweiterung .md um anzugeben, dass der Beitrag im Markdown-Format verfasst ist. (und bitte verfassen Sie Beiträge nur mit Markdown)

Nach diesen Regeln könnte ein Blogbeitrag, der die Eröffnung der GFP 2017 ankündigt, den folgenden Dateinamen haben:

 2017-06-19-CFP-open.md

Bitte fügen Sie außerdem oben in Ihrer Datei Folgendes hinzu:

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

Legen Sie title auf den Titel Ihres Blog-Beitrags fest und bearbeiten Sie tags so, dass sie das Konferenzjahr enthalten, mit dem der Beitrag verknüpft ist (leer, wenn keines vorhanden ist). Bitte lassen Sie die restlichen Werte unverändert.

Für den eigentlichen Dateiinhalt können Sie Ihre Änderungen entweder in der GitHub-Weboberfläche oder auf Ihrem lokalen Rechner vornehmen.

Auf GitHub

Navigieren Sie zu dem Verzeichnis, in dem sich die Datei befindet, die Sie bearbeiten oder hinzufügen möchten (wahrscheinlich _posts ).
So erstellen Sie eine neue Datei:
- Klicken Sie auf Create a new file
- Benennen Sie Ihre Datei (gemäß den Anweisungen oben, wenn es sich um einen Blog-Beitrag handelt)
Nehmen Sie Ihre Änderungen vor
- So erstellen Sie eine neue Datei:
  - Klicken Sie auf Create a new file
  - Geben Sie einen Dateinamen ein (gemäß der obigen Anleitung, wenn es sich um einen Blog-Beitrag handelt).
- So bearbeiten Sie eine vorhandene Datei:
  - Klicken Sie auf die Datei, um sie auszuwählen
  - Klicken Sie auf das kleine Stiftsymbol
- In jedem Fall können Sie die Datei jetzt in der Weboberfläche bearbeiten.
Übernehmen Sie Ihre Änderungen mithilfe des Formulars Commit changes unterhalb der Bearbeitungsoberfläche.
- Geben Sie einen kurzen, aber aussagekräftigen Titel ein, z. B. „Hinzufügen der CFP-Eröffnungsankündigung 2017“.
- Geben Sie eine detaillierte Beschreibung ein. Wenn Sie an einem Problem arbeiten, geben Sie hier bitte die Problemnummer an. Verwenden Sie ein Hashmark ( # ), gefolgt von einer Problemnummer ( #74 ). Dies wird automatisch im Pull-Request verlinkt, was wirklich praktisch ist.

Auf Ihrem lokalen Computer

TBD (es wird davon ausgegangen, dass diejenigen, die Git auf ihren lokalen Computern verwenden, dies bereits wissen; werden es später ergänzen)

Klonen Sie Ihre Gabel
Nehmen Sie Ihre Änderungen vor (Dateien hinzufügen und/oder bearbeiten)
Übertragen Sie Ihre Änderungen zurück in Ihren Fork

Testen Sie Ihre Änderungen

Bitte testen Sie alle Änderungen lokal, bevor Sie sie auf GitHub übertragen.

Lokaler Entwicklungsserver

Durch das Starten eines lokalen Entwicklungsservers wird Ihre Kopie der Site unter http://localhost:4000 verfügbar gemacht. Es gibt verschiedene Möglichkeiten, den Server auszuführen. Treffen Sie Ihre Wahl!

Option 1: Blankes Metall

Abhängigkeiten:

Rubin
Bundler

Einmalige Einrichtung:

bundle install

Starten Sie den Server:

bundle exec jekyll serve --watch

Um eine Vorschau zukünftiger und unveröffentlichter Beiträge anzuzeigen, fügen Sie --future --unpublished zum obigen Befehl hinzu.

Option 2: Containerisiert

Abhängigkeiten:

Docker (oder Podman; ersetzen Sie docker durch podman )

Einmalige Einrichtung:

docker build --tag ' seagldev ' ' . '

Starten Sie den Server:

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

Um eine Vorschau zukünftiger und unveröffentlichter Beiträge anzuzeigen, fügen Sie --future --unpublished am Ende des obigen Befehls hinzu.

Senden Sie eine Pull-Anfrage (PR) für die Änderungen

Sie können eine PR entweder über die GitHub-Schnittstelle oder von Ihrem lokalen Computer aus senden.

Auf GitHub

Navigieren Sie in Ihrem Browser zu Ihrem Fork des seagl.github.io-Repositorys.
Klicken Sie auf die Registerkarte Pull requests .
Klicken Sie auf die New pull request button .
GitHub erkennt, dass es sich bei Ihrem Repo um einen Fork handelt, und stellt standardmäßig den PR als Hauptzweig Ihres Forks ein, der eine Anfrage an den Hauptzweig von seagl.github.io stellt. Die Chancen stehen sehr gut, das ist es, was Sie wollen. Wenn nicht, wissen Sie genug, um dies zu erkennen. :-)
Klicken Sie auf Create pull request .
Geben Sie einen kurzen, aber aussagekräftigen Titel ein, z. B. „Hinzufügen der CFP-Eröffnungsankündigung 2017“.
Geben Sie eine detaillierte Beschreibung ein. Wenn Sie an einem Problem arbeiten, geben Sie hier bitte die Problemnummer an. Verwenden Sie ein Hashmark ( # ), gefolgt von einer Problemnummer ( #74 ). Dies wird automatisch im Pull-Request verlinkt, was wirklich praktisch ist.
Wählen Sie [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) damit andere Teammitglieder bei Bedarf Änderungen vornehmen können.
Klicken Sie auf Create pull request .

Auf Ihrem lokalen Computer

TBD (es wird davon ausgegangen, dass diejenigen, die Git auf ihren lokalen Computern verwenden, dies bereits wissen; werden es später ergänzen)

Ihre Änderungen werden live veröffentlicht

Jetzt muss jemand (vielleicht Sie, wenn Sie über diese Zugriffsebene auf das Repo verfügen) Ihre Pull-Anfrage überprüfen und dann zusammenführen.

Sobald Ihre Pull-Anfrage zusammengeführt ist, wird sie auf der Website live geschaltet.

HINWEIS : Die Zusammenführung selbst löst keinen Neuaufbau der Website aus. Um die Site neu zu erstellen, müssen Sie einen leeren Commit wie folgt pushen:

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

So fügen Sie Bilder zu Beiträgen hinzu

Fügen Sie Ihr Bild dem Verzeichnis img/posts/ hinzu und verwenden Sie dann den folgenden Markdown:

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

Tipps:

Um das Bild seitlich auszurichten, fügen Sie die Klasse align-left oder align-right hinzu:
```
 ![ Example description ] ( /img/posts/example.jpg ) {:.align-left}
```
Um die Seitenladezeiten zu verlängern, sollten Sie die Größe von Bildern auf eine angemessene Größe anpassen, bevor Sie sie in einem Beitrag verwenden.