In der Welt der Dokumentation und Content-Erstellung ist Markdown seit Jahren ein beliebtes Format. Einfach zu schreiben und gleichzeitig gut lesbar, hat Markdown zahlreiche Entwickler, Autoren und Blogger begeistert. Doch trotz seiner Vorteile gibt es immer wieder Herausforderungen, vor allem wenn es um komplexere Dokumente und die Lesbarkeit des Quellcodes geht. Hier setzt Shrimple an – eine modernere, bereinigte und übersichtlichere Alternative zu Markdown, die das Schreiben von Dokumenten effizienter, klarer und ästhetisch ansprechender gestaltet. Shrimple ist nicht nur eine neue Markup-Sprache, sondern bietet auch einen statischen Site-Generator, der den gesamten Prozess der Website-Erstellung aus Shrimple-Quellen vereinfacht und optimiert.
Shrimple zeichnet sich zunächst durch sein klares und sauberes Syntaxdesign aus, das eine bessere Lesbarkeit sowohl im Rohtext als auch im HTML-Output garantiert. Anders als bei Markdown, das manchmal durch unsaubere Inline-URLs oder uneinheitliche Tabellenlayouts aufgebläht wird, erlaubt Shrimple eine elegantere Handhabung von Links durch die Verwendung von Fußnoten. Fußnoten dienen hier nicht nur als zusätzliche Erläuterungen, sondern übernehmen auch die Aufgabe, URLs außerhalb des eigentlichen Textflusses zu organisieren. Dadurch bleibt der Text schlanker, und längere URLs beeinträchtigen nicht die Übersichtlichkeit. Gleichzeitig bleiben diese Fußnoten leicht zugänglich und funktionieren wie Verweise in einem wissenschaftlichen Dokument.
Ein weiteres herausragendes Merkmal von Shrimple ist seine sehr differenzierte Unterstützung von Codeblöcken und Inline-Code. Die Syntax ist so gestaltet, dass selbst komplexe Codebeispiele einfach zu schreiben sind, ohne die Lesbarkeit im Quelltext zu beeinträchtigen. Codeblöcke müssen mit sechs Leerzeichen eingerückt werden – eine Regel, die sicherstellt, dass leere Zeilen innerhalb des Codes nicht als Trenner interpretiert werden und der gesamte Codeblock als Einheit bleibt. Optional kann eine Sprachbezeichnung hinzugefügt werden, zum Beispiel „ Go“, was beim Rendern als HTML-Klasse im Codeblock erscheint. Dies ermöglicht eine passgenaue automatische Hervorhebung mit Tools wie Prism.
js, die Syntaxfehler reduziert und die Lesbarkeit des dargestellten Codes steigert. Die Behandlung von Listen in Shrimple ist ebenfalls intelligent gestaltet. Sowohl ungeordnete (Bullet-) als auch geordnete (nummerierte) Listen verwenden eine einheitliche Einrückung von zwei Leerzeichen, was für Konsistenz im Quelltext sorgt. Außerdem müssen längere Listeinträge, die sich über mehrere Zeilen erstrecken, mit zusätzlichen Leerzeichen eingerückt werden, um die visuelle Struktur klar zu erhalten. Anders als bei vielen Markdown-Varianten müssen nummerierte Listen nicht mit der Ziffer „1“ wiederholt werden, sondern können beliebige Zahlen enthalten.
Shrimple normalisiert diese automatisiert und stellt so eine fortlaufende Zahlenreihenfolge beim Rendern sicher. Das ist ein kleiner, aber feiner Detailvorteil gegenüber klassischen Markdown-Lösungen, die hier oft eingeschränkt sind oder eine manuelle Korrektur erfordern. Die Überschriften in Shrimple gliedern sich in zwei Ebenen, „h1“ und „h2“. Diese werden über die sogenannte „Dicke“ von Unterstrichen definiert: Dreifache Gleichheitszeichen markieren die erste Ebene, dreifache Bindestriche die zweite. Neben der optischen Klarheit sorgt eine feste Regel dafür, dass die Zeichen auf der Folgelinie mindestens drei Zeichen lang sein müssen, um als Überschrift erkannt zu werden.
Diese einfache, aber strikte Regel vermeidet versehentlich falsch formatierte Überschriften und somit unerwünschte Formatierungsfehler. Ein interessanter Aspekt von Shrimple sind die sogenannten „Notes“ – spezielle Hervorhebungen, die mit einem Wort in Großbuchstaben auf einer eigenen Zeile beginnen, etwa NOTES:, ATTENTION: oder SIDENOTE:. Diese Notizen werden im gerenderten HTML als spezielle, mit CSS zu formatierende Blöcke dargestellt. Der Vorteil liegt darin, dass der Schreiber wichtige Hinweise, Nebengedanken oder Warnungen klar und übersichtlich im Dokument platzieren kann, ohne den Lesefluss zu stören oder auf komplizierte HTML-Markups zurückgreifen zu müssen. Die Einrückung erlaubt es zudem, längere Notizen mit mehreren Absätzen sinnvoll zu strukturieren.
Eine der innovativsten Funktionen von Shrimple sind seine Parse- und Render-Dictionaries. Diese dienen dazu, bestimmte Wörter oder Ausdrücke im Text automatisch hervorzuheben oder zu verlinken, ohne zusätzliche Markups in den Dokumenten einzufügen. Statt den Text mit diversen Tags oder Zeichen zu versehen, definiert man in externen Wörterbüchern, welche Schlüsselwörter wie dargestellt werden sollen. Dabei kann unter anderem die Farbe, Unterstreichung oder andere Stilmittel verwendet werden, und mehrere Wörter oder Ausdrücke können differenziert behandelt werden. Diese Funktion ist besonders wertvoll bei großen Dokumentationen oder Wissensdatenbanken, in denen bestimmte Begriffe besonders betont oder verlinkt werden sollen, ohne den Ursprungstext unübersichtlich zu machen.
Die Handhabung über die Kommandozeile mit den Optionen -p (parse dictionary) und -r (render dictionary) macht den Prozess flexibel und gut steuerbar. Neben der Syntax und den neuen Funktionen zur Textformatierung bringt Shrimple einen eigenen statischen Website-Generator mit. Dieser ermöglicht es, ein ganzes Verzeichnis voller Shrimple-Quelldateien in eine statische Website zu verwandeln, indem jede Datei in eine HTML-Seite übersetzt wird. Dabei entsteht automatisch eine Navigation mit vorheriger und nächster Seite sowie ein verschachteltes Menü, das die Seitenstruktur übersichtlich abbildet. Dies ist insbesondere für Dokumentationen oder mehrteilige Tutorials interessant, denn der Besucher bekommt eine klare Orientierungshilfe.
Die Struktur der Quelldateien wird dabei über eine einfache Nummerierung gesteuert, die eine Reihenfolge vorgibt und sicherstellt, dass die Navigation logisch und hilfreich funktioniert. Der Generator weist mehrere praktische Eigenschaften auf: So werden nur veränderte Dateien bei erneutem Generieren aktualisiert, was Zeit spart. Die erstellten Seiten enthalten auf Wunsch ein Standard-Stylesheet, können aber auch ein eigenes CSS verwenden. Für Anwender, die kein vollwertiges Webhosting betreiben möchten, ist hervorzuheben, dass die erzeugten HTML-Dateien inklusive Navigation jederzeit lokal per Browser geöffnet werden können, ohne einen Webserver zu benötigen. Dieses Feature unterstützt eine flexible Nutzung, vom lokalen Workflow bis zur Veröffentlichung im Internet.
Für Entwickler und technisch versierte Nutzer bietet Shrimple einen einfachen Workflow, der viele lästige Details automatisiert. Die Abhängigkeit von Go für die Kompilierung ist für diejenigen, die in der Softwareentwicklung tätig sind, normalerweise kein Hindernis, da Go leicht installiert und verwendet werden kann. Die Kommandozeilenoptionen sind klar und sinnvoll strukturiert, sodass auch komplexere Aufgaben wie das gleichzeitige Erzeugen von Webseiten, das Hinzufügen von Navigation und Menüs oder das Einbinden externer Stylesheets mit wenigen Argumenten erledigt werden können. Shrimple steht in einer spannenden Tradition von Markup-Sprachen, die versuchen, die Balance zwischen einfacher Textverarbeitung, Lesbarkeit und Flexibilität zu finden. Während Markdown als Pionier gilt, sind die begrenzten Funktionen und einige inkonsistente Regeln in der Praxis oft eine Herausforderung.
Shrimple geht einen Schritt weiter und adressiert diese Schwachstellen gezielt. Außerdem ist die Vision, nicht nur eine Syntax zu bieten, sondern ein ganzes Ökosystem mit Parsern, Renderer, statischem Site-Generator und sogar speziellen Wörterbüchern zu schaffen, bemerkenswert und bietet besonders Dokumentationsteams und Entwicklern einen echten Mehrwert. Die Verfügbarkeit auf GitHub und eine einfache Dokumentation mit Beispielen erleichtern den Einstieg. Das Projekt versteht es, sich an Praktiken der Open-Source-Welt anzulehnen und lädt zur aktiven Mitgestaltung ein. Die Integration mit bewährten Tools wie Prism.
js zur Codehervorhebung rundet das Paket sinnvoll ab und macht Shrimple zu einer professionellen Lösung für viele Anwendungsfälle. Besonders interessant ist die Möglichkeit, Inhalte klar und semantisch zu strukturieren, ohne auf konzeptionelle Kompromisse oder komplexe Workarounds zurückgreifen zu müssen. Indem Shrimple die Syntax durch klare Regeln definiert und gleichzeitig Flexibilität durch externe Konfigurationsdateien für Wörterbücher bietet, entsteht eine Arbeitsumgebung, die sowohl für Autoren als auch für Leser von Dokumentationen einen echten Gewinn darstellt. Neben dem technischen Nutzen ist Shrimple auch in Hinblick auf das Design der erstellten Dokumente zu erwähnen. Durch die Einbindung eines CSS-Stylesheets, sei es das eingebaute Standard-Stylesheet oder eine individuell gestaltete Variante, sorgen die erzeugten HTML-Seiten für ein ansprechendes Erscheinungsbild.
Klare Typografie, definierte Abstände und eine konsistente Farbpalette fördern die Nutzerfreundlichkeit und erhöhen die Akzeptanz bei den Lesern. Durch die Verwendung von Fußnoten als Mittel zur Linkverwaltung und zusätzlichen Anmerkungen wird bei Shrimple ein deutlicher Schritt in Richtung Wissenschaftlichkeit und Professionalität vollzogen. Diese Herangehensweise erleichtert das Erstellen von Dokumenten, die später referenziert, erweitert oder in größeren Kontexten eingesetzt werden sollen. Im Gegensatz zu herkömmlichen teils chaotischen Inline-Links entsteht eine übersichtliche und wartbare Struktur. In Summe bietet Shrimple eine moderne, durchdachte und praktische Alternative für Menschen, die regelmäßig mit Text und Code in Dokumentationsform arbeiten und dabei großen Wert auf Übersichtlichkeit, Flexibilität und gutes Design legen.
Die Kombination von sauberer Syntax, innovativen Features wie Parse- und Render-Dictionaries sowie einem leistungsfähigen statischen Website-Generator macht Shrimple zu einem wertvollen Werkzeug im Werkzeugkasten von professionellen Autoren, Entwicklern und technischen Redakteuren. Wer auf der Suche nach einer Markdown-Variante ist, die in puncto Klarheit, Erweiterbarkeit und professionellem Output neue Maßstäbe setzt, sollte Shrimple unbedingt ausprobieren. Nicht nur die Dokumentation und das Schreiben gewinnen dadurch an Qualität, sondern auch die daraus generierten Webseiten können sich sehen lassen und sind zugleich einfach zu pflegen und zu erweitern. Weitere Informationen, Beispiele und den Quellcode finden Interessierte unter https://code.qount25.
dev/qount25/Shrimple. Dort gibt es auch Anleitungen zur Installation, Nutzung der verschiedenen Features und Hinweise zur aktiven Mitarbeit am Projekt. Shrimple steht bereit, um die Art und Weise der technischen Dokumentation nachhaltig zu verändern.
