Dokumentation: Website aufsetzen

1. Schritt: Repository von Github klonen und/oder forken

REPOSITORY

ACHTUNG: bitte das Repository stolpersteine und nicht stolpersteine-docs klonen, im letzteren befindet sich nur die Dokumentation.

Das geklonte Repository hat drei Branches:

master - der Branch, der nun gebraucht wird
gh-pages - Stolperstein-Daten für Heilbronn (kann gelöscht werden)
javascript - ein Prototyp für die Seite (kann gelöscht werden)


2. Konfiguration

Da die Seite mit Jekyll gebaut ist, ist sie sehr einfach zu konfigurieren. In der Datei _config.yml sind einige Werte, die man verändern sollte:

title: Stolpersteine <MEINE STADT>
email: info@example.com
description: 'Lorem ipsum'
baseurl: "/pfad"
url: https://example.com

Des weiteren sollte man die Koordinaten der Stadt eingeben, in der sich das Stolpersteine-Projekt, befindet. Die Koordinaten kann man ganz einfach z.B. bei gps-coordinates.net bekommen.

# lat. and long. coordinates for the map in list.html
lat: 49.1426929
long: 9.210878999999977

Eine weitere Konfigurationsoption ist interessant: Wenn man das Attribut blog auf true setzt, wird ein Blog für die Seite aktiviert (die Blogbeiträge aufgelistet).

# blog posts shown in index.html
blog: true

Wenn man die Links in Footer oder Header bearbeiten will, muss man diese manuell einfügen, dafür gibt es die Dateien _data/footer.yml und _data/header.yml

Man fügt einen Link wie folgt ein:

- title: SICHTBARER TEXT
  link: /pfad/pfad/datei

3. Deployment & Website lokal testen

Am einfachsten ist es, die Seite mit Github-Pages zu hosten. Man muss nur für den neuen Branch master hosting aktivieren in den Repo-Einstellungen:
gh-pages.png

Lokal testen

  1. Jekyll installieren
  2. cd stolpersteine
  3. jekyll serve
    -> Wir benutzen keine Gems oder Bundler o. Ä.

4. Zur Stolperstein-Liste hinzufügen

Bitte öffnen Sie einen Issue / Pull Request bei dem Repository stolpersteine-docs oder schreiben Sie eine Mail (lukas@himsel.me), damit wir Ihr Exemplar der Stolperstein-Seite in der Projekte-Übersicht listen können.


Wie man Inhalte ohne Texteditor mit schönem visuellen Editor bearbeitet, wird als nächstes erklärt:

Nächstes: Inhalte einpflegen