RubyFrontierDocs, warum nicht?

Mir gefällt ja die Art, wie man mit MkDocs und Markdown relativ leicht (Online-) Dokumentationen und Handbücher erstellen kann. Aber manchmal ist mir die Software einfach zu starr und unbeweglich, da wünsche ich mir mehr Eingriffsmöglichkeiten, auch wenn sie eventuell zu Lasten des Komforts gehen.

Und da ist mir eingefallen, daß ich vor etwa sieben Jahren schon einmal so etwas ähnliches mit RubyFrontier versucht hatte, als ich ein RubyFrontier-Buch schreiben wollte. Zwar ist RubyFronter nicht gerade der schnellste Generator für statische Seiten, aber dafür kann man als versierter Nutzer überall eingreifen und das Teil nach seinem Gusto anpassen. Der Beweis ist dieses Blog Kritzelheft, das seit 2012 mit RubyFrontier erstellt wird.

Im Gegensatz zu dem Python-Markdown von MkDocs ist außerdem kramdown, der Markdown-Dialekt, den ich RubyFrontier untergeschoben habe, näher an dem Markdown-Dialekt, den Pandoc verwendet, so daß es relativ einfach sein sollte, aus den RubyFrontier-Quellen mithilfe von Pandoc auch ein gedrucktes Buch oder ein Ebook zu erstellen. Vielleicht gelingt es mir sogar, Pandoc auch RubyFrontier unterzujubeln. 🤓

Daher habe ich kurzerhand das Template zu meinem (nie fertiggestellten) RubyFrontier-Buch auf das Notwendigste eingedampft und auf den aktuellen Stand von Ruby und RubyFrontier gebracht, und so ein Framework erschaffen, das als Grundlage für in Markdown erstellte Dokumentationen und Bücher dienen kann. Ich habe es RubyFrontierDocs genannt und auf GitHub veröfffentlicht. Ich werde es benutzen, um eine schon lange geplante Dokumentation zu erstellen und die Erkenntnisse daraus jeweils in RubyFrontierDocs einfließen lassen.

[Caveat]: In den Jahren von 2012 bis heute haben sich sowohl Ruby wie auch RubyFrontier verändert. Das RubyFrontier-Buch ist daher nicht mehr auf dem aktuellen Stand. Und RubyFrontierDocs läuft nach ersten Probeläufen zwar so, wie ich es mir vorstelle, aber ob sich nicht doch noch ein paar historische Ungereimtheiten dahinter verbergen, kann ich noch nicht genau sagen. Daher: Handle with Care!

Vielleicht inspriert mich die Betätigung mit RubyFrontierDocs aber auch, die Arbeit an dem RubyFrontier-Buch wieder aufzunehmen. Schließlich bin ich ja Rentner und da macht man manchmal so etwas.

(Kommentieren)