jmmasw

Machen Sie mir einfach eine statische Website

JMMASW ist ein einfaches Tool für ein einfaches Problem: statische Websites.

Betrieb

1. Laden Sie alle Dateien mit der Erweiterung ".html" oder ".tmpl"
2. Nehmen Sie jede Datei in eine GO -Vorlage an
3. Laden Sie die Datendatei ("./data.json" pro Standard))
4. Führen Sie alle Vorlagen mit einem Namen aus, der in ".html" endet "
5. Schreiben Sie die Ausgabe in Dateien, es sei denn, sie ist leer

Verwendung

JMMASW akzeptiert die folgenden Befehlszeilenparameter:

• data - Speicherort der Datendatei
• dir - Projektort, Standard ist das aktuelle Verzeichnis
• static-out -Ausgaberklärung, Standard ist ./jasw-out (für "nur eine statische Website Out"))
• ignore-no-data -Standard für True. Wenn auf False eingestellt ist, führt eine fehlende Datendatei zur Beendigung des Programms

Gebäude

JMMASW wird mit GO1.8 erstellt, sodass Sie mindestens GO1.8 für den funktionieren, aber auch älteren Versionen funktionieren können (aber keine Versprechen)

So installieren Sie einfach die folgenden Befehle aus:

 go get go.rls.moe/jmmasw
go install go.rls.moe/jmmasw

Vorlagen

Informationen zum Vorlageformat finden Sie in den Godoc -Einträgen zu html/template und text/template .

Vorlagen werden durch ihren Dateinamen definiert, aber wenn Sie die Vorlagen manuell definiert haben, gilt dies nicht.

Nur Vorlagen mit einem Namen, der in ".html" endet, werden gerendert, ".TMPL" -Dateien werden nur analysiert und sind für gemeinsame Funktionen gedacht.

Vorlagenfunktionen

• file akzeptiert eine einzelne Zeichenfolge als Parameter und versucht, das angegebene Dateiformular das Dateisystem zu lesen
• json analysiert eine bestimmte Zeichenfolge in das JSON-Format, die Struktur der obersten Ebene muss eine Karte sein, einfache Arrays sind nicht zulässig
• markdown macht eine bestimmte Zeichenfolge mit Markdown -Prozessoren ohne Bereinigung in HTML (Verwenden Sie nicht auf Benutzereingaben!)
• dict akzeptiert eine beliebige Anzahl von Schlüsselwertpaaren mit einem String-Typ-Schlüssel und gibt das Ergebnis zurück. Dies ermöglicht es, mehrere Variablen zu einer einzelnen Pipeline zu kombinieren

Roadmap

• Fügen Sie Markdown -Parser- und Markdown -Dateiloader ein
• Funktionieren Sie, um zusätzliche .json -Dateien innerhalb der Vorlagen zu analysieren
• Methode zur Ignorierung bestimmter Verzeichnisse
• Funktion zum Ausgabedateien, die nicht als Vorlagen vorhanden sind
  • Beispiel: Index.html generiert Index-en.html und index-de.html anstelle von index.html

Warten Sie was?

Wenn Sie sich fragen, warum dieses Tool existiert: Ich habe es geschafft, damit ich meine Website für mehrere Sprachen generieren kann, ohne die Hälfte der Website ständig kopieren zu müssen.

Ich habe Hugo in Betracht gezogen, ein ausgezeichneter statischer Seitengenerator, aber für diese Anwendung ist es auch viel zu kompliziert. JMMASW arbeitet mit "RAW" -HTML -Vorlagen und geht nicht über Ihre Website.

Sie können Ihre Website so aufnehmen, wie sie jetzt ist und vorausgesetzt, sie enthält keinen ungültigen Go-Template-Code, er wird das andere Ende von JMMASW ohne Änderung ergeben.