menimal

Menimal ?

Menimal est un générateur de site statique minimal.

Concentrez-vous sur le contenu : écrivez simplement des fichiers markdown, des styles CSS et tout le reste est généré pour vous

Menimal est minimal de par sa conception :

• Pas de javascript (pas de package.json )
• Aucun modèle HTML
• Pas de mdx
• Pas de référencement ni de métadonnées

---

• Commencer
  • Déployer
• Structure des dossiers
  • pages
  • static
  • config.json
  • style.css
• Feuille de route
• Licence
• Remarques
  • Autres générateurs de sites statiques
  • Développement
  • Mise en œuvre

Commencer

Menimal est un script npx unique que vous pouvez exécuter de partout sans installer de package.

Assurez-vous que NodeJs est installé sur votre machine

Il vous suffit d'exécuter une seule commande :

npx menimal

Cela générera un dossier build contenant votre site Web statique.

Déployer

Les plateformes d'hébergement permettent de définir une commande de build et un dossier de sortie :

• Commande de construction : npx menimal
• Dossier de sortie : build

C'est tout. Vous pouvez déployer Menimal partout ?

---

Structure des dossiers

Menimal nécessite une structure de dossiers précise :

• pages : contient des fichiers de démarque ( .md )
• static : contient des fichiers statiques ( robots.txt , fonts , favicon.ico )
• config.json : contient la configuration du site (minimale)
• style.css : contient des styles (un seul fichier CSS)

Voir un exemple complet et fonctionnel dans le dossier d'exemple

pages

Chaque fichier markdown correspondra à une page .html du site Web.

Le nom du fichier .md est utilisé pour générer à la fois le nom du fichier HTML et le titre de la page :

• Fichier HTML : identique au .md avec tous les caractères minuscules
• Titre : identique à .md avec - remplacé par des espaces

Par exemple, This-is-the-Title-of-the-article.md générera :

• HTML : this-is-the-title-of-the-article.html
• Titre : Ceci est le titre de l'article

static

Tous les fichiers contenus dans static seront copiés dans la version finale.

Ici, vous pouvez ajouter des images, des polices, robots.txt , favicon.ico , sitemap.xml ou quoi que ce soit de vraiment ??‍♂️

config.json

Pour l'instant config nécessite un seul champ : le nom du site affiché dans <header> :

{
  "name" : " Sandro Maglione "
}

style.css

Tous les styles sont définis dans un seul fichier CSS .

Vous pouvez afficher la structure HTML générée de chaque fichier dans les modèles

Ce fichier sera minifié et importé dans chaque page générée.

Feuille de route

• Précharger les polices en HTML

 < link rel =" preload " href =" font.woff2 " as =" font " crossorigin type =" font/woff2 " > 

Licence

Licence MIT, voir le fichier LICENSE.md pour plus de détails.

---

Remarques

Ce projet fait partie de ma newsletter hebdomadaire sur sandromaglione.com .

Autres générateurs de sites statiques

• Hexo
• Jekyll
• Hugo

Développement

• Utilisez npx --loglevel silly .. à partir du dossier example pour déboguer la commande npx

Mise en œuvre

Lire tous les détails de la mise en œuvre dans l'article complet ?