Ajoutez votre Thème Hugo à la Galerie

Une collection de tous les thèmes créés par la communauté Hugo, y compris des captures d’écran et des démos, se trouve à l’adresse https://themes.gohugo.io. Chaque thème de cette liste sera automatiquement ajouté au site des thèmes. Les mises à jour de thèmes ne sont pas programmées, mais elles se produisent généralement au moins une fois par semaine.

tl;dr

1. Créez votre thème en utilisant hugo new theme <NOMTHEME> ;
2. Testez votre thème contre https://github.com/spf13/HugoBasicExample *
3. Ajoutez un fichier theme.toml à la racine de votre thème avec toutes métadonnées requises
4. Ajoutez un README.md descriptif à la racine du thème source
5. Ajoutez /images/screenshot.png et /images/tn.png

* Si votre thème ne correspond pas au site Hugo Basic Example, nous encourageons les auteurs de thème à fournit un site Hugo auto-contenu dans /exampleSite.

Regardez l’exampleSite du thème Hugo Artist pour un bon exemple.

Exigences du Thème

Afin d’ajouter votre thème à la Galerie (Showcase), les exigences suivantes doivent être satisfaites :

1. theme.toml avec tous les champs requis
2. Images miniature et capture-écran
3. Un bon fichier README d’instructions pour les utilisateurs
4. Ajout au repo GitHub hugoThemes

Ajoutez Votre Thème au Repo

Le moyen le plus facile d’ajouter votre thème est d’ouvrir un nouvel “issue” dans le repo du thème avec un lien vers le repo de votre thème sur GitHub.

Créez un fichier theme.toml

theme.toml contient des métadonnées sur le thème et son créateur et devrait être créée automatiquement lors du lancement de la commande hugo new theme. Le fichier généré automatiquement est fourni ici aussi pour un téléchargement facile :

name = ""
license = "MIT"
licenselink = "https://github.com/<VOTRENOM>/<VOTRETHEME>/blob/master/LICENSE.md"
description = ""
homepage = "http://votresite.com/"
tags = []
features = []
min_version = 0.19

[author]
  name = ""
  homepage = ""

# Si portage d'un thème existant
[original]
  name = ""
  homepage = ""
  repo = ""

Les champs suivant sont obligatoires :

name = "Hyde"
license = "MIT"
licenselink = "https://github.com/spf13/hyde/blob/master/LICENSE.md"
description = "An elegant open source and mobile first theme"
homepage = "http://siteforthistheme.com/"
tags = ["blog", "company"]
features = ["blog"]
min_version = 0.13

[author]
    name = "spf13"
    homepage = "http://spf13.com/"

# Si portage d'un thème existant
[original]
    author = "mdo"
    homepage = "http://hyde.getpoole.com/"
    repo = "https://www.github.com/mdo/hyde"

Images

Les captures d’écran sont utilisées pour des aperçus dans la galerie de thème Hugo. Assurez-vous qu’elles aient les bonnes dimensions :

• La miniature devrait être de 900px × 600px
• La capture d’écran devrait être de 1500px × 1000px
• Les médias doivent être posés dans
  • /images/screenshot.png</ code>
  • /images/tn.png</ code>

Des médias supplémentaires peuvent être fournis dans le même répertoire.

Créer un fichier README

Le fichier README de votre thème doit être écrit en markdown et sauvegardé à la racine de la structure de répertoire de votre thème. Votre README.md sert de

1. Contenu pour la page de détails de votre thème sur https://themes.gohugo.io
2. Informations générales sur le thème dans votre dépôt GitHub

Exemple README.md

Vous pouvez télécharger le README.md suivant comme un aperçu :

# Theme Title

**Need input from @digitalcraftsman on what could be added to this file.**