Création d'un nouveau thème :: Dokumentationen — Addon Documentation
Création d’un nouveau thème
Ce tutoriel vous montrera comment créer un thème simple pour Hugo. Je suppose que vous êtes familier avec HTML, la ligne de commande bash, et que vous êtes à l’aise avec Markdown pour formater le contenu. Je vais expliquer comment Hugo utilise des modèles et comment vous pouvez organiser vos modèles pour créer un thème. Je ne couvrirai pas l’utilisation de CSS pour styliser votre thème.
Dans ce tutoriel, les commandes que vous entrez commenceront par l’invite “$”. La sortie suivra. Les lignes qui commencent par “#” sont des commentaires que j’ai ajoutés pour expliquer un point. Lorsque je montre les mises à jour d’un fichier, le “:wq” sur la dernière ligne signifie qu’il faut sauvegarder le fichier.
Les skins sont les fichiers responsables de l’apparence de votre site. C’est le CSS qui contrôle les couleurs et les polices, c’est le Javascript qui détermine les actions et les réactions. Ce sont aussi les règles que Hugo utilise pour transformer votre contenu en HTML que le site montrera aux visiteurs.
Vous avez deux façons de créer un skin. Le moyen le plus simple est de le créer dans le répertoire layouts/. Si vous le faites, vous n’avez pas à vous soucier de configurer Hugo pour le reconnaître. Le premier endroit où Hugo recherchera pour les règles et les fichiers se trouve dans le répertoire layouts/ afin de trouver toujours le skin.
Votre deuxième choix est de le créer dans un sous-répertoire du répertoire themes/. Si vous le faites, vous devez toujours indiquer à Hugo où chercher le skin. C’est un travail supplémentaire, cependant, alors, pourquoi s’embêter avec ça?
La différence entre la création d’un skin dans layouts/ et la création dans themes/ est très subtile. Un skin dans layouts/ ne peut pas être personnalisé sans mettre à jour les modèles et les fichiers statiques sur lesquels il est construit. Un skin créé dans themes/, d’autre part, peut être et facilite son utilisation par d’autres personnes.
Notez que vous pouvez utiliser ce tutoriel pour créer un skin dans le répertoire layouts/ si vous le souhaitez. La principale différence sera que vous n’aurez pas besoin de mettre à jour le fichier de configuration du site pour utiliser un thème.
La page d’accueil, ou la page de destination, est la première page que beaucoup de visiteurs d’un site voient. C’est le fichier index.html dans le répertoire racine du site Web. Puisque Hugo écrit des fichiers dans le répertoire public/, notre page d’accueil est public/index.html.
Lorsque Hugo s’exécute, il recherche un fichier de configuration qui contient des paramètres qui remplacent les valeurs par défaut pour l’ensemble du site. Le fichier peut utiliser TOML, YAML ou JSON. Je préfère utiliser TOML pour mes fichiers de configuration. Si vous préférez utiliser JSON ou YAML, vous devrez traduire mes exemples. Vous devrez également modifier le nom du fichier puisque Hugo utilise l’extension pour déterminer comment le traiter.
Hugo traduit les fichiers Markdown en HTML. Par défaut, Hugo s’attend à trouver des fichiers Markdown dans votre répertoire content/ and les modèles dans le répertoire themes/. Il créera les fichiers HTML dans votre répertoire public/. Vous pouvez le modifier en spécifiant d’autres emplacements dans le fichier de configuration.
La section liminaire est une information sur le contenu. Comme le fichier de configuration, il peut être écrit en TOML, YAML ou JSON. Contrairement au fichier de configuration, Hugo n’utilise pas l’extension du fichier pour connaître le format. Il recherche des marqueurs pour signaler le type. TOML est entouré de “+++”, YAML par “---”, et JSON est enfermé dans des accolades. Je préfère utiliser TOML, donc vous devrez traduire mes exemples si vous préférez YAML ou JSON.
L’information dans la section liminaire est transmise au modèle avant que le contenu ne soit rendu en HTML.
Hugo utilise sa connaissance du contenu pour trouver le modèle a utiliser pour rendre le contenu. S’il ne peut pas trouver un modèle qui correspond exactement au contenu, il changera de niveau et recherchera à partir de là. Il continuera à le faire jusqu’à ce qu’il trouve un modèle correspondant ou ne dispose plus de modèles à essayer. S’il ne peut pas trouver un modèle, il utilisera le modèle par défaut pour le site.
Un modèle de liste rend un groupe de contenu connexe. Cela pourrait être un résumé des publications récentes ou de tous les articles d’une catégorie. Les modèles de liste peuvent contenir plusieurs groupes.
Le modèle de la page d’accueil est un type spécial de modèle de liste. Hugo suppose que la page d’accueil de votre site servira de portail pour le reste du contenu sur le site.
Un modèle partiel est un modèle qui peut être inclus dans d’autres modèles. Les modèles partiels doivent être appelés en utilisant la commande de modèle “partial”. Ils sont très utiles pour utiliser des comportement commun. Par exemple, votre site peut avoir une bannière que toutes les pages utilisent. Au lieu de copier le texte de la bannière dans chaque modèle simple et de liste, vous pouvez créer une partie avec la bannière. De cette façon, si vous décidez de modifier la bannière, il vous suffit de changer le modèle partiel.
Utilisons Hugo pour créer un nouveau site Web. Je suis un utilisateur Mac, alors je vais créer le mien dans mon répertoire personnel, dans le dossier Sites. Si vous utilisez Linux, vous devrez d’abord créer le dossier.
La commande “new site” créera un squelette d’un site. Il vous donnera la structure de répertoire de base et un fichier de configuration utilisable.
Consultez le répertoire content/ pour confirmer qu’il est vide.
Les autres répertoires (archetypes/, layouts/ et static/) sont utilisés lors de la personnalisation d’un thème. C’est un sujet pour un tutoriel différent, alors ignorez-les pour l’instant.
Éxécuter la commande hugo sans options permet de lire tout le contenu disponible et de générer les fichiers HTML. Il copiera également tous les fichiers statiques (tout ce qui n’est pas du contenu). Comme nous avons un site vide, il ne fera pas grand chose, mais il le fera très rapidement.
Le drapeau “--verbose “donne des informations supplémentaires qui seront utiles lorsque nous créerons le modèle. Chaque ligne de sortie qui commence par “INFO:” ou “WARN:” est présente car nous avons utilisé ce drapeau. Les lignes qui commencent par “WARN:” sont des messages d’avertissement. Nous les examinerons plus tard.
Voyez-vous ce nouveau répertoire public/ ? Hugo y a placé tout le contenu généré. Lorsque vous êtes prêt à publier votre site Web, c’est l’endroit idéal pour commencer. Pour l’instant, nous allons simplement confirmer que nous avons ce que nous attendons pour un site sans contenu.
Hugo a créé deux fichiers XML, ce qui est standard, mais il n’y a pas de fichiers HTML.
Connectez-vous à l’URL répertorié (c’est sur la ligne qui commence par “Web Server”). Si tout fonctionne correctement, vous devriez obtenir une page qui montre ce qui suit:
C’est une liste de votre répertoire public/. Hugo n’a pas créé une page d’accueil car notre site n’a aucun contenu. Quand il n’y a pas de fichier index.html dans un répertoire, le serveur répertorie les fichiers dans le répertoire, ce que vous devriez voir dans votre navigateur.
Ce deuxième avertissement est plus facile à expliquer. Nous n’avons pas créé un modèle à utiliser pour générer des “erreurs de page non trouvées”. Le message 404 est un sujet pour un tutoriel distinct.
À propos du premier avertissement. C’est pour la page d’accueil. Vous pouvez le dire parce que la première mise en page qu’il recherchait était “index.html”. Cela n’est utilisé que par la page d’accueil.
J’aime que le drapeau verbose demande à Hugo de lister les fichiers qu’il recherche. Pour la page d’accueil, ce sont index.html, _default/list.html et _default/single.html. Il y a des règles que nous aborderons plus loin qui expliquent les noms et les chemins. Pour l’instant, n’oubliez pas que Hugo n’a pas pu trouver un modèle pour la page d’accueil et il vous l’a dit.
À ce stade, vous avez une installation de travail et un site sur lequel nous pouvons développer. Tout ce qui reste, c’est d’ajouter du contenu et un thème pour l’afficher.
Hugo ne fournit pas de thème par défaut. Il y a quelques-uns disponibles (j’ai compté une douzaine lorsque j’ai installé Hugo pour la première fois) et Hugo contient une commande pour créer de nouveaux thèmes.
Nous allons créer un nouveau thème appelé “zafta”. Étant donné que le but de ce didacticiel est de vous montrer comment remplir les fichiers pour extraire votre contenu, le thème ne contiendra aucun CSS. En d’autres termes, moche mais fonctionnel.
Tous les thèmes utilisent des philosophies différentes sur le contenu et la mise en page. Les philosophies fortes permettent de créer un thème facilement, mais différentes philosophies rendrons l’utilisation du thème plus difficile. Par exemple, Zafta utilise “post” au lieu de “blog”. Lorsque vous construisez un thème, envisagez d’utiliser les termes que d’autres thèmes utilisent.
Utilisez la commande “new” de Hugo pour créer le squelette d’un thème. Cela crée la structure du répertoire et place les fichiers vides à remplir.
Maintenant que nous avons un thème sur lequel travailler, il est judicieux d’ajouter le nom du thème au fichier de configuration. Ceci est facultatif, car vous pouvez toujours ajouter “-t zafta” à toutes vos commandes. J’aime mettre le fichier de configuration car j’aime les lignes de commande plus courtes. Si vous ne le placez pas dans le fichier de configuration ou ne le spécifiez pas sur la ligne de commande, vous n’utiliserez pas le modèle que vous attendez.
Avez-vous remarqué que la sortie est différente? Le message d’avertissement pour la page d’accueil a disparu et nous avons une ligne d’information supplémentaire indiquant que Hugo est en train de se synchroniser avec le répertoire du thème.
Hugo a créé une page d’accueil. C’est le fichier public/index.html.
Hugo a affirmé avoir créé 0 pages. Il a créé un fichier et copié sur des fichiers statiques, mais n’a pas créé de pages. C’est parce qu’il considère une «page» comme un fichier créé directement à partir d’un fichier de contenu. Il ne compte pas les choses comme les fichiers index.html qu’il crée automatiquement.
Hugo prend en charge plusieurs types de modèles différents. La page d’accueil est spéciale car elle possède son propre type de modèle et son propre fichier modèle. Le fichier, layouts/index.html, sert à générer le HTML pour la page d’accueil. La documentation de Hugo indique que c’est le seul modèle requis, mais cela dépend. Le message d’avertissement d’Hugo montre qu’il recherche trois modèles différents:
S’il ne trouve aucun de ces derniers, il saute complètement la création de la page d’accueil. Nous avons remarqué que lorsque nous avons construit le site sans avoir un thème installé.
Lorsque Hugo a créé notre thème, il a créé un modèle de page d’accueil vide. Maintenant, lorsque nous construisons le site, Hugo trouve le modèle et l’utilise pour générer le HTML pour la page d’accueil. Comme le fichier modèle est vide, le fichier HTML est également vide. Si le modèle avait eu des règles, Hugo les aurait utilisé pour générer la page d’accueil.
Hugo suppose que votre site utilisera à la fois CSS et JavaScript, de sorte qu’il crée des répertoires sur votre thème pour les retenir. Rappelez-vous les philosophies ? Eh bien, la philosophie de Hugo est que vous allez stocker votre CSS dans un répertoire nommé css/ et votre JavaScript dans un répertoire nommé js/. Si vous n’aimez pas cela, vous pouvez modifier les noms de répertoire dans votre répertoire de thème ou même les supprimer complètement. Hugo est assez agréable pour offrir son avis, puis bien se comporter si vous êtes en désaccord.
Le cycle de développement d’un site
Revenez à l’étape 4.
Je vais vous donner un conseil: ne jamais travailler sur un thème sur un site en production. Toujours travailler sur une copie de votre site. Effectuez des modifications sur votre thème, testez-les, puis copiez-les sur votre site. Pour plus de sécurité, utilisez un outil comme Git pour garder un historique de révision de votre contenu et de votre thème. Croyez-moi quand je dis qu’il est trop facile de perdre vos changements.
Consultez le site Hugo principal pour obtenir de l’information sur l’utilisation de Git avec Hugo.
Remarque: Si vous utilisez un SSD, vous devez ignorer cela. L’agitation sur un SSD peut être coûteuse.
L’option watch de Hugo
L’option “--watch” de Hugo va surveiller les changements dans le répertoire content/ et les répertoire de vos thème afin de regénérer le site automatiquement.
Le serveur web intégré de Hugo supporte les rechargements en direct. Lorsque qu’une page est sauvegardée sur le serveur, le navigateur est amené à rafraîchir la page. Habituellement, cela se produit avant que vous puissiez dire “Woah, c’est incroyable.”
L’exemple de sortie suivant montre que Hugo detecte une modification sur le modèle de la page d’accueil. Après l’avoir générée, le serveur web va automatiquement recharger la page. Je l’ai dit précédement, c’est incroyable.
Mettre à jour le modèle de la page d’accueil
La page d’accueil est l’une des quelques pages spéciales que Hugo crée automatiquement. Comme mentionné précédemment, il recherche l’un des trois fichiers dans le répertoire de mise en page (layout/) du thème:
Nous pourrions mettre à jour l’un des modèles par défaut, mais une bonne décision de conception est de mettre à jour le modèle le plus spécifique disponible. Ce n’est pas une règle difficile et rapide (en fait, nous ne la respecterons pas plusieurs fois dans ce tutoriel), mais c’est une bonne généralisation.
À l’heure actuelle, cette page est vide car nous n’avons aucun contenu et nous n’avons aucune logique dans le modèle. Changeons cela en ajoutant du texte au modèle.
Note: Si vous avez lancé le serveur avec l’option --watch, vous verrez un contenu différent dans le fichier :
Lorsque vous utilisez --watch, le script de rechargement automatique est ajouté par Hugo. Renseignez-vous dans la documentation avec les termes live reload pour voir qu’est-ce qu’il fait et comment le désactiver.
Créer une page d’accueil “dynamique”
“Une page d’accueil dynamique ?” Hugo est un générateur de site statique, cela paraît étrange à dire. Je veux dire que la page d’accueil reflète le contenu du site chaque fois que Hugo le regénère. Nous allons utiliser l’itération dans le modèle pour faire cela.
Maintenant que nous avons la page d’accueil générée avec un contenu statique, ajoutons du contenu au site. Nous allons lister ces articles sur la page d’accueil et sur leurs propre page également.
Hugo a une commande pour générer un squelette d’article, comme il le fait pour les sites et les thèmes.
C’est pas bon, n’est-ce pas ?
La commande “new” utilise un archétype pour créer le fichier de l’article. Hugo crée un fichier d’archétype vide par défault, mais cela provoque une erreur lorsqu’il y a un thème. Pour moi, la solution était de créer un fichier d’archétype spécifiquement pour le type article.
La sortie annonce qu’il a créé 2 pages. Ce sont nos nouveaux articles:
Les nouveaux fichiers sont vides parce que les modèles utilisé pour générer le contenu sont vides. La page d’accueil n’affiche pas non plus le nouveau contenu. Nous devons modifier les modèles pour ajouter les articles.
Avec Hugo, nous avons trois principaux types de modèles. Il y a le modèle de page d’accueil que nous avons édité précédement. Il est utilisé seulement pour la page d’accueil. Nous avons également le modèles simple qui sont utilisés pour générer du contenu simple. Et nous avons les modèles de liste qui sont utilisés pour grouper plusieurs contenus.
D’une manière générale, les modèles de liste sont nommés “list.html” et les modèles simples sont nommés “single.html”.
Ajouter du contenu sur la page d’accueil
La page d’accueil contiendra une liste d’articles. Modifions son modèle pour ajouter les articles que nous venons de créer. La logique dans le modèle s’éxecutera chaque fois que nous génèrerons notre site.
Hugo utilise le moteur de modèle de Go. Ce moteur analyse les fichiers de modèle pour y trouver des commandes qui sont spécifiées entre “{{” et “}}”. Dans notre modèle, les commandes sont:
La commande “range” est un itérateur. Nous allons l’utiliser pour parcourir les dix premières pages. Chaque fichier HTML que Hugo crée est traité comme une page. Donc, boucler autour de la liste des pages examinera chaque fichier qui a été crée.
La commande “end” signale la fin de l’itération. Le moteur retourne en haut de l’itération lorsque qu’il trouve “end”. Tout ce qui est entre “range” et “end” est évalué chaque fois que le moteur passe par l’itération. Dans ce fichier, cela va afficher le titre des dix premières pages dans la sortie comme titre de niveau 1.
Félicitation, la page d’accueil affiche le titre des deux articles. Les articles eux-même sont toujours vide, mais prenez un moment pour apprécier ce que nous avons effectué. Votre modèle génère maintenant des sorties dynamiquement. Croyez-le ou non, en insérant la commande “range” à l’intérieur de ces accolades, vous avez appris tout ce que vous devez savoir pour créer un thème. Tout ce qu’il reste vraiment est de comprendre quel modèle va être utilisé pour générer chaque fichier de contenu et de devenir familier avec les commandes du moteur de modèles.
Et, si c’est entièrement vrai, ce tutoriel devrai être plus court. Il y a quelques choses à savoir qui rendrons la création de nouveaux thèmes plus facile. Ne vous inquiétez pas, ca va bien se passer.
Ajouter du contenu à l’article
Nous travaillons avec des articles, qui sont stockés dans le répertoire content/post/. Cela signifie que leur section est “post” (et si nous n’avons rien fait de travers, leur type est également “post”).
Hugo utilise la section et le type pour définir le modèle pour chaque partie du contenu. Hugo va d’abord chercher un modèle qui correspond à la section ou au type. S’il n’arrive pas à en trouver un, il va alors chercher dans le répertoire _default/. Il y a quelques cas que nous allons couvrir lorsque nous travaillerons avec les catégories et les tags, mais pour le moment, nous supposerons que Hugo va essayer post/single.html, puis _default/single.html.
Nous pourrions créer un nouveau modèle, post/single.html, ou modifier le modèle par défaut. Comme nous n’utilisons actuellement aucun autre type de contenu, commençons par mettre à jour le modèle par défaut.
Sovenez-vous, tout contenu pour lequel nous n’avons pas créé de modèle utilisera ce modèle. Cela peut être bien ou mauvais. Mauvais parce que je sais que nous allons ajouter d’autres types de contenu et nous allons devoir annuler certaines des modifications que nous avons effectuées. Mais c’est bien parce que nous allons pouvoir voir directement les résultats. C’est également bien de démarrer ici car nous pouvons commencer à faire la mise en place basique du site. Comme nous ajouterons plus de contenu, nous remanierons ce fichier et déplacerons la logique ailleur. Hugo fait cela plutôt bien, donc nous accepterons le coût et procèderons.
Les articles sont sur la page d’accueil. Ajoutons un lien d’ici vers l’article. Comme cela se trouve sur la page d’accueil, nous allons mettre à jour le modèle.
Nous avons les articles affichés sur la page d’accueil et sur leur propre page. Nous avons également un fichier public/post/index.html qui est vide. Faisons en sorte qu’il liste tous les articles (pas seulement les dix premiers).
Comme pour l’article seul, nous devons décider d’éditer _default/list.html ou de créer post/list.html. Nous n’avons toujours pas plusieurs types de contenu, alors restons cohérant et éditons le modèle de liste par défaut.
Création d’une page de haut niveau
Ajoutons une page “à propos” et affichons la au plus haut niveau (à l’opposé d’un sous-niveau comme nous avons fait pour les articles).
La valeur par défaut de Hugo consiste à utiliser la structure du répertoire content/ pour guider l’emplacement du HTML généré dans le répertoire public/. Vérifions cela en créant une page “à propos” (about dans l’exemple) au plus haut niveau:
Notez que la page n’a pas été crée au plus haut niveau. Ça a créé un sous répertoire nommé ‘about-time’. Ce nom vient de notre slug. Hugo va l’utiliser pour nommer les contenu générés.
Autre chose : regardez la page d’accueil.
Notez que le liens vers “about” est listé avec les articles. Ce n’était l’effet désire, corrigeons donc cela d’abord.
Générez le site web et vérifiez le résultat. La page d’accueil a deux sections, articles et pages, et chaque section contient le bon ensemble de lien
Générez le site web et vérifiez que cela ne fonctionne pas. Hugo laisse le slug ou l’URL outrepasser l’option des liens permanents dans le fichier de configuration. Commentez le slug dans content/about.md, puis générez le site web pour qu’elle soit générée au bon endroit.
Si vous avez suivi, vous avez sûrement remarqué que les articles ont un titre dans le navigateur et pas la page d’accueil. C’est parce que nous n’avons pas mis de titre dans le modèle de la page d’accueil (layout/index.html). C’est quelque chose de facile, mais utilisons une option différente.
Création du modèle partiel de l’entête et du pied de page
Avec Hugo, un modèle partiel est un modèle embelli. Normalement, un modèle fait référence à un chemin spécifique. Les modèles partiels sont différents. Hugo les recherche le long d’un chemin de recherche défini. Cela permet aux utilisateurs finaux de remplacer plus facilement la présentation du thème.
Modification du modèle de page d’accueil pour utiliser les modèles partiels
La différence notable entre un appel d’un modèle et celui d’un modèle partiel est le manque de chemin:
Changeons le modèle de la page d’accueil pour utiliser ces nouveaux modèles partiels.
Générez le site web et vérifiez le résultat. Le titre sur la page d’accueil est maintenant “your title here”, qui de la variable “title” dans la fichier config.toml.
Il est commun de voir la date à laquelle un article a été écrit ou publié, donc ajoutons cela. La section liminaire de notre article possède une variable nommée “date”. C’est généralement la date de la création du contenu, mais supposons que c’est la valeur que nous souhaitons afficher.
Générez le site web et vérifiez le résultat. Les articles ont maintenant la date affiché. Mais il y a un problème, la page “a propos” a également la date d’affichée.
Comme d’habiture, il y a différent moyens d’afficher la date seulement sur les articles. Nous pourrions utiliser un “if” comme nous l’avons fait sur la page d’accueil. Une autre méthode serait de créer un modèle séparer pour les articles.
La solution du “if” fonctionne pour les site n’ayant que quelques types de contenu. Il s’harmonise avec le principe du “code pour aujourd’hui”, aussi.
Admettons que nous avons rendu notre site tellement complexe que nous estimons qu’il faut créer un nouveau type de modèle. En langage Hugo, nous allons créer un modèle de section.
Restaurons le modèle simple par défaut avant d’oublier.
Maintenant, nous allons modifier le modèle simple des articles. Si vous vous souvenez des règles d’Hugo, le moteur de modèles va utiliser cette version à la place de celle par défaut.
DRY (Don’t Repeat Yourself) est un bon objectif de conception et Hugo fait du bon boulot pour supporter cette idée. Une partie de l’art du bon modèle est de savoir quand il faut ajouter un nouveau modèle ou quand il faut modifier un existant. Avant de saisir complétement ce principe, faites vous à l’idée que vous allez devoir faire de la refactorisation. Hugo rend cela facile et rapide, il est donc préférable de diviser un modèle.
Zuletzt aktualisiert 28.09.2014