Da ich in meinem Blog überwiegend über technischen Themen schreibe, die oft auch Codeschnipsel enthalten, möchte ich diese mithilfe einer Syntaxhervorhebung lesbarer machen. Vor vielen Jahren habe ich mich für ein Plugin entschieden, das auch auf wordpress.com standardmäßig verfügbar ist. Es kommt mit verschiedenen Stilen und unterstützt viele Programmiersprachen. Für Programmiersprachen, die fehlen, findet man oft ein Zusatz-Plugin. Oder man schreibt ein eigenes, wie ich es getan habe.

Das SyntaxHighlighter Evolved Plugin wurde ursprünglich von Alex Mills entwickelt, der leider 2019 verstorben ist. Die Entwicklung wird nun von Automattic fortgesetzt.

Was macht SyntaxHighlighter Evolved?

Wie der Name schon sagt, ist es ein Plugin zum Syntax-Highlighting (auf Deutsch „Syntaxhervorhebung“) von Code. Ich verwende es in jedem Blogbeitrag, in dem ich Code mit euch teile. Ihr könnt einen Legacy-Shortcodes verwenden, entweder einen pro Programmiersprache wie oder einen generischen, bei dem die Programmiersprache als Parameter angegeben wird, wie direkt in euren Beiträgen und Seiten. Ihr könnt aber auch einen Block verwenden und die Programmiersprache in den Blockeinstellungen auswählen. Dort könnt ihr auch andere Optionen einstellen, wie z.B. das Hervorheben bestimmter Zeilen oder das Einblenden von Zeilennummern.

Das Plugin verwendet den syntaxhightligher von Alex Gorbatchev, der noch aktiv gepflegt wird. Es wird mit zwei verschiedenen "Hightlighter-Versionen" geliefert: 2.x und 3.x - man kann immer nur eine verwenden. Ich benutze immer noch Version 2, da sie eine "wraplines" Funktion bietet, die ich sehr nützlich finde. Es gibt auch eine Version 4, aber diese wurde noch nicht in das Plugin integriert.

Warum verwende ich SyntaxHighlighter Evolved?

Ich verwende in meinen Beiträgen regelmäßig Codebeispiele. Da ich diese lesbarer machen will, möchte ich einen Syntaxhighlighter verwenden. Ich habe mich vor vielen Jahren für dieses Plugin entschieden und die Umstellung auf ein anderes wäre eine ziemliche Aufgabe. Da es aber nicht mehr mit der neuesten Version des Pakets aktualisiert wurde, ist es vielleicht an der Zeit, einen Ersatz zu finden. Außerdem kommt es manchmal in Codeblöcken zu Fehlern, insbesondere wenn HTML oder einige "HTML-Spezialzeichen" in anderen Programmiersprachen enthalten sind.

Add-ons zum Plugin, die ich verwende

Ich verwende zwei Add-ons. Da ich einige Blogbeiträge über den Apache-Webserver habe, und die Hervorhebung für die Konfigurationsdateien ist nicht im Kernpaket enthalten, verwende ich das "SyntaxHighlighter Evolved: Apache" Plugin, das aber nicht im WordPress.org Plugin Verzeichnis zu finden ist. Es kann nur auf einer externen Website heruntergeladen werden. Ich habe auch viel über Sass gebloggt, und da es für diese Sprache kein Add-on-Plugin gab, habe ich eines erstellt: "SyntaxHighlighter Evolved: SASS Brush". Diese Zusatz-Plugins müssen selten aktualisiert werden. Nur wenn sich die Schlüsselwörter einer solchen Sprache ändern. Für mein Sass-Plugin verwende ich einfach die offizielle JavaScript-Datei mit diesen Schlüsselwörtern und aktualisiere sie in meinem Plugin.

Fazit

Wenn ihr besser lesbare Codeschnipsel in euren Beiträgen und Seiten anbieten möchtet, kann ein Plugin zur Syntaxhervorhebung einen großen Unterschied machen. Ich benutze immer noch ein ziemlich altes, aber es funktioniert noch.

Verwendet ihr auch ein Plugin für die Syntaxhervorhebung? Vielleicht kennt ihr ja eines, das eine "wraplines" Funktion bietet und besser gewartet wird als das von mir eingesetzte. Dann teilt es bitte in einem Kommentar mit mir, ich würde es gerne ausprobieren.