Statische Webseiten mit Pelican erstellen
Der Inhalt
In Pelican wird zwischen zwei verschiedenen Inhaltstypen unterschieden. Dies sind zum einen Seiten (»pages«) und zum anderen Artikel.
Wie zu Beginn dieses Artikels schon erwähnt, lassen sich Artikel in reStructuredText, Markdown oder AsciiDoc schreiben. Exemplarisch als Erläuterung folgt nun ein Artikel in Markdown.
Title: Pelican-Beispielartikel in Markdown Category: Sonstiges Date: 20-14-27-04 13:37 # Lorem Ipsum Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore ...
Das obige Beispiel zeigt, wie ein Artikel in Markdown aussehen kann. Vor dem eigentlichen Artikel folgt der Header, in dem einige Informationen angegeben werden können. Title gibt selbstredend den Titel des Blog-Artikels an. Mit Einträgen in Category können Kategorien eingetragen werden, in welchen der Artikel erscheinen soll. Die Kategorien enthalten dann beim Erzeugen der HTML-Dateien den entsprechenden Artikel. Jede Kategorie besitzt zusätzlich einen RSS-Feed. Der dritte Punkt ist hier das Datum, welches das Veröffentlichungsdatum des Blog-Artikels darstellt. Die drei aufgeführten Punkte sind nicht die einzigen; es gibt auch noch einige weitere Daten, die man angeben kann, wie etwa einen speziellen Slug, einen Autor oder auch eine Zusammenfassung des Artikels.
Der eigentliche Text enthält in diesem Beispiel lediglich eine Markdown-Syntax, nämlich das #. Dies ist das Markdown-Zeichen, welches eine Überschrift der ersten Ebene darstellt. Es kann in Artikeln aber auf die volle Markdown-Sprache zurückgegriffen werden.
Neben Artikeln können auch normale Seiten angelegt werden, wie etwa eine Impressum-Seite. Dazu reicht es, wenn man einen pages-Ordner innerhalb des content-Ordners erstellt und dort die relevanten Seiten anlegt.
Einstellungen
Die Einstellungsmöglichkeiten von Pelican sind sehr vielfältig. Die Basis-Konfigurationsdatei ist standardmäßig pelicanconf.py. Dort sind unter anderem auch die Optionen enthalten, die man beim Anlegen des Blogs spezifiziert hat.
Wenn der Blog bloß von einer einzigen Person befüllt wird, bietet es sich an, einen Default-Autor zu setzen. Dafür steht die Option AUTHOR zur Verfügung. Weiterhin kann man in SITEURL den Seitennamen anpassen, sofern man den ursprünglichen Namen beim Erzeugen des Blogs ändern möchte.
Wenn man von einer anderen Blog-Software wechselt oder besondere Wünsche für die URLs der einzelnen Seiten und Artikel hat, bietet es sich an, die URLs entsprechend zu konfigurieren.
Die URL-Konfiguration kann beispielsweise wie folgt aussehen:
ARTICLE_URL = 'blog/{date:%Y}/{date:%m}/{date:%d}/{slug}/'
ARTICLE_SAVE_AS = 'blog/{date:%Y}/{date:%m}/{date:%d}/{slug}/index.html'
Alle Blog-Artikel liegen unter dem Unterverzeichnis blog. Dahinter folgen die Zahlen für das Jahr, Monat, Tag und schlussendlich der Slug. Die resultierende URL sieht also so aus: /blog/2014/04/27/suchen-und-finden-mit-ack-statt-grep/. Der Blog-Artikel wird allerdings in einer einzelnen HTML-Datei gespeichert, so dass Pelican für jeden einzelnen Blog-Artikel die Ordner-Struktur erzeugt und dort eine index.html-Datei anlegt.
Die vollständigen Einstellungsmöglichkeiten von Pelican findet man in der Dokumentation.
Plug-ins
Die Basisfunktionalität von Pelican lässt sich mit Hilfe von Plug-ins erweitern. Hierfür gibt es ein offizielles Github-Repositorium, welches von den Pelican-Entwicklern gepflegt wird. Plug-ins werden aber hauptsächlich von externen Helfern eingereicht. Im Repositorium kann man stöbern und diverse Plug-ins ausprobieren. So gibt es beispielsweise Plug-ins zum Erzeugen von PDF-Dateien aus den Artikeln oder ein Plug-in zum einfachen Einbinden von YouTube-Videos.
Themes
Ebenfalls in einem Github-Repositorium finden sich eine größere Anzahl an Themes, die man für seinen Pelican-Blog einsetzen kann. Nach dem Herunterladen des Repositorys reicht es, wenn man ein Theme in der Konfigurationsdatei spezifiziert.
Falls man nicht eines der vorgegebenen Themes nutzen will, kann stattdessen man auch ein eigenes Theme für Pelican entwickeln. Wie das geht, kann man ebenfalls in der Dokumentation nachlesen.
Fazit
Mit Pelican lässt sich schnell und einfach ein statischer Blog aufsetzen und betreiben. Er kommt mit allen Vor- und Nachteilen von statischen Blogs daher. Wer eine sinnvolle Kommentarfunktion vermisst, muss sich mit externen Diensten aushelfen, wie zum Beispiel Disqus. Für bereits existierende Blogs gibt es auch ein Importwerkzeug, welches Artikel in das Pelican-Format überträgt. Mit den zahlreichen Konfigurationsmöglichkeiten ist es zudem möglich, seinen Blog bis ins Detail so anzupassen, wie man es möchte.
Autoreninformation
Sujeevan Vijayakumaran (Webseite) setzt seit einiger Zeit auf einen statischen Blog. Zuerst nutzte er Blogofile, stieß dann aber auf die bessere Alternative Pelican.
Dieser Artikel ist in freiesMagazin 07/2014 (ISSN 1867-7991) erschienen. Veröffentlichung mit freundlicher Genehmigung.
