Installation: Introduction

Gestion des versions#

Assets utilisées dans le thème#

ApplicationVersion minimum
Hugo (Extended version)
Bulma
Plusieurs autres assets sont utilisés dans Shadocs. Leurs versions sont disponibles dans le fichier .bmycconfig.json, et les assets sont automatiquements mis à jour grâce à la librairie Bmyc .

Installation#

Création d’un site Hugo#

Pour créer un site Hugo, la documentation Hugo propose un Quickstart complet qui reprend l’ensemble des étapes necessaires afin de créer facilement et rapidement un site Hugo.

Ajout du thème#

  1. Pour pouvoir ajouter et utiliser le thème Shadocs avec un site Hugo il utiliser l’une des possibilités suivantes:

    • Ajouter le thème en tant que sous-module Git au projet du site (Méthode recommandée)
      cd ${REPERTOIRE_PROJET}
git submodule add https://github.com/jgazeau/shadocs.git themes/shadocs
git submodule update --init --recursive
    • Télécharger les sources du thème et les ajouter au projet du site dans le répertoire themes/shadocs

  2. Ajouter le thème au fichier de configuration du site:

    config.toml
    [...]
theme = "shadocs"
[...]