jmmasw

Faites-moi juste un site Web statique

JMMASW est un outil simple pour un problème simple: les sites Web statiques.

Opération

1. Chargez tous les fichiers avec l'extension ".html" ou ".tmp"
2. Analyser chaque fichier dans un modèle GO
3. Chargez le fichier de données ("./data.json" par défaut)
4. Exécutez tous les modèles avec un nom qui se termine par ".html"
5. Écrivez la sortie dans des fichiers à moins qu'il ne soit vide

Usage

JMMASW accepte les paramètres de ligne de commande suivants:

• data - Emplacement du fichier de données
• dir - Emplacement du projet, la valeur par défaut est le répertoire actuel
• static-out - Répertoire de sortie, par défaut est ./jasw-out (pour "juste un site Web statique")
• ignore-no-data - par défaut est vrai. Si défini sur false, un fichier de données manquant entraîne la fin du programme

Bâtiment

JMMASW est construit en utilisant Go1.8, vous devez donc au minimum l'installation de Go1.8 pour que cela fonctionne, mais les versions plus anciennes pourraient aussi fonctionner (mais pas de promesses)

Pour installer, exécutez simplement les commandes suivantes:

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

Modèles

Pour plus d'informations sur le format de modèle, reportez-vous aux entrées GODOC sur html/template et text/template .

Les modèles sont définis par leur nom de fichier, mais si vous avez défini manuellement les modèles, cela ne s'applique pas.

Seuls les modèles avec un nom qui se termine par ".html" seront rendus, les fichiers ".tmpl" seront uniquement analysés et sont destinés à des fonctionnalités communes.

Fonctions de modèle

• file accepte une seule chaîne comme paramètre et tente de lire le formulaire de fichier spécifié Le système de fichiers
• json analyse une chaîne donnée au format JSON, la structure de niveau supérieur doit être une carte, les tableaux simples ne sont pas autorisés
• markdown rend une chaîne donnée dans HTML à l'aide de processeurs Markdown sans aucune désinfection (n'utilisez pas sur les entrées utilisateur!)
• dict accepte n'importe quel nombre de paires de valeurs clés avec une clé de type chaîne et renvoie le résultat. Cela permet de combiner plusieurs variables en un seul pipeline

Feuille de route

• Inclure l'analyseur Markdown et le chargeur de fichiers Markdown
• Fonction pour analyser les fichiers .json supplémentaires à partir des modèles
• Méthode pour ignorer les répertoires spécifiques
• Fonction à la sortie des fichiers qui ne sont pas présents comme modèles
  • Exemple: index.html génère index-en.html et index-de.html au lieu d'index.html

Attendez quoi?

Si vous vous demandez pourquoi cet outil existe: je l'ai fait pour que je puisse générer mon site Web pour plusieurs langues sans avoir à copier-coller la moitié du site Web tout le temps.

J'ai considéré Hugo, qui est un excellent générateur de pages statique, mais il est également trop compliqué pour cette application. JMMASW travaille avec des modèles HTML "RAW" et ne fait aucune hypothèse sur votre site Web.

Vous pouvez prendre votre site Web tel qu'il est maintenant et à condition qu'il ne contienne pas de code go-template non valide, il sortira l'autre extrémité de JMMASW sans changement.