clair-berlin.de

In diesem Repository liegt der Quellcode der Clair Berlin Website¹. Wir verwenden Jekyll als Static Site Generator.

Der Inhalt der Website ist lizenziert unter einer Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 4.0 International Lizenz .

How To Development

Install dependencies:

  $ gem install jekyll bundler
  $ bundle install

Deploy locally: jekyll serve --livereload

Server will listen on http://127.0.0.1:4000

Inhalte

Die einzelnen Seiten der Website werden aus Markdown-Dateien im obersten Verzeichnis des Repositorys generiert. Lediglich dieses README.md ist in der Jekyll-Konfigarionsdatei explizit ausgeschlossen. Jekyll verwendet kramdown und unterstützt dementsprechend dessen erweiterte Syntax.

Daten für die Navigation, die Angaben im Footer und vor allem die Homepage werden in YAML-Dateien im _data-Verzeichnis gepflegt.

Layout

Jede Seite sollte im Front Matter das zu verwendende Layout angeben, z. B.:

layout: page

Die verschiedenen Layouts liegen im _layouts-Verzeichnis. Das Standard-Layout ist page, das Kerngerüst ist in default.html definiert.

Das derzeitige Design verwendet Bootstrap und Font Awesome Icons, deren SASS (bzw. SCSS)-Dateien im _sass-Verzeichnis liegen und in main.scss eingebunden werden.

Partials, die in mehreren Layouts verwendet werden, wie z. B. Footer und Navigation liegen im _includes-Verzeichnis.

Navigation

Die Links der Navigation werden in der Datei nav.yml gepflegt. Bei Bedarf muss das dazu gehörige Partial angepasst werden.

Bilder und Downloads

Grundsätzlich kopiert Jekyll im Wesentlichen sämtliche Dateien ohne Front Matter inklusive Unterordner in die gerenderte Website. Bilder sollten im Verzeichnis img abgelegt werden, allgemeine Downloads wie z. B. PDF-Dokumente unter downloads.

Das Format für die Markdown-Einbindung von Bildern sieht dann so aus

![Alternativer Text]({{ "/img/bild.jpg" | relative_url }})

das für Downloads so:

[Link-Text]({{ "/downloads/file.pdf" | relative_url }})

Die Verwendung des Liquid-Filters relative_url stellt sicher, dass z. B. für Test-Deployments in einem Unterverzeichnis, für das die baseurl-Konfiguration verwendet wird, die Links korrekt funktionieren.

Neuigkeiten (Blog)

Neuigkeiten bzw. anekdotische Blog-Posts sollten Jekylls Standard-Post-Mechanismus folgen.

Folgende Kategorien sollten verwendet werden:

• Technik
• Presse

Footnotes

1. The Clair Platform and the Clair-Berlin initiative are now part of the CO2-Monitoring (COMo) project, funded by a grant from the Senate Chancellery of the Governing Mayor of Berlin. ↩