Prêt à démarrer avec Gantry 5 ? C'est super! Nous sommes là pour vous aider.
Sur cette page, vous obtiendrez quelques conseils rapides pour vous aider à démarrer avec Gantry 5. Vous pouvez trouver une documentation plus détaillée pour chacun de ces conseils en cliquant sur le bouton En savoir plus au bas de chaque section.
Nous espérons que vous apprécierez Gantry 5 autant que nous avons aimé le créer.
Les exigences d’administration back-end de Gantry, par ordre de préférence, sont les suivantes :
Remarque : Internet Explorer n'est plus pris en charge
Gantry 5 est un cadre dans lequel les thèmes basés sur Gantry sont créés. Pour qu'un thème Gantry fonctionne, vous devrez installer à la fois le framework et le thème . Faire cela n’est pas difficile du tout.
La première chose que vous devez faire est de télécharger la dernière version de Gantry 5 et Hydrogen. Vous pouvez le faire en cliquant sur les liens ci-dessous ou via GitHub.
Téléchargement stable | Télécharger les versions CI |
---|
Une fois que vous disposez des derniers packages, l’installation est simple. Nous avons fourni un guide étape par étape dans la partie Installation de cette documentation.
Apprendre encore plus
Une fois que vous avez installé et activé à la fois le framework Gantry et Hydrogen, vous pouvez accéder à l'administrateur Gantry 5 de plusieurs manières différentes. Le plus simple étant simplement de naviguer vers Composants > Modèles Gantry 5 depuis le back-end de Joomla.
Ici, vous verrez une liste de tous les thèmes basés sur Gantry installés. Vous pouvez prévisualiser le thème à partir d'ici ou sélectionner Configurer pour accéder directement à l' administrateur Gantry où vous pouvez commencer à modifier votre site Gantry.
L'administrateur Gantry dispose de plusieurs outils d'administration que vous pouvez parcourir pour configurer l'apparence et le fonctionnement de votre thème Gantry. Voici un aperçu rapide de chacun de ces outils et de ce que vous pouvez faire avec eux.
Vous remarquerez les éléments de menu suivants dans l'administrateur Gantry 5 :
Éditeur de menu : ce panneau d'administration vous donne la possibilité d'améliorer le menu de la plateforme en modifiant le style, en réorganisant les liens et en créant des éléments de menu qui se trouvent en dehors du gestionnaire de menu intégré du CMS.
À propos : cette page vous donne des informations rapides et en un coup d'œil sur le thème actuellement consulté. Il s'agit d'un guichet unique pour obtenir des informations sur le thème, notamment : le nom, le numéro de version, le créateur, les liens d'assistance, les fonctionnalités, etc.
Paramètres de la plateforme : ce bouton vous amène à la page des paramètres du CMS pour Gantry 5. Dans Joomla, il s'agit de la page de configuration des autorisations .
Effacer le cache : ce bouton efface les fichiers de cache liés à Gantry. Cela inclut tous les fichiers temporaires en dehors du CSS et des informations de configuration.
Liste déroulante Outlines : cette liste déroulante facilite le basculement rapide entre les Outlines sans avoir à quitter l'administrateur Gantry.
Styles : Ce panneau d'administration vous donne accès aux paramètres de contour liés au style. Cela inclut des éléments tels que les couleurs du thème, les polices, les préréglages de style, etc.
Paramètres : Ce panneau d'administration vous offre la possibilité de configurer les paramètres fonctionnels du thème. Cela inclut la définition des valeurs par défaut pour les particules, ainsi que l'activation/la désactivation des particules individuelles.
Mise en page : Ce panneau d'administration est l'endroit où vous configurerez la mise en page de votre thème. La création d'un module de placement de positions, de particules, d'espaceurs et de scripts non rendus tels que le code Google Analytics se fait dans ce panneau.
Apprendre encore plus
Parce que Gantry 5 est si différent de toutes les versions de Gantry précédentes, nous avons trouvé quelques termes pour aider à donner un sens aux relations que les nouvelles fonctionnalités de Gantry entretiennent entre elles. Voici une brève description des termes couramment utilisés liés à Gantry 5.
Terme | Définition |
---|---|
Contour | Un style configurable utilisé dans une ou plusieurs zones de votre site. Il sert de conteneur sur lequel le style, les paramètres et la mise en page d'une page sont définis. |
Particule | Un petit bloc de données généralement utilisé sur le front-end. Il agit un peu comme un widget/module, mais peut être facilement configuré dans l'administrateur Gantry 5. |
Atome | Type de particule qui contient des données non rendues, telles que des scripts personnalisés (JS, CSS, etc.) ou des scripts d'analyse pour le suivi du trafic. |
Apprendre encore plus
Un salon de discussion a été mis en place à l'aide de Gitter où vous pouvez parler du projet avec les développeurs, les contributeurs et d'autres membres de la communauté. C'est le meilleur endroit où aller pour obtenir des conseils rapides et discuter des fonctionnalités avec d'autres.
La documentation est également disponible et est continuellement complétée au fur et à mesure de la progression du développement. Il manque quelque chose ? Vous pouvez contribuer à la documentation via GitHub.
Contribuer au framework Gantry 5, ou à sa documentation associée est simple. Le développement de ces deux projets est effectué via Github, où vous pouvez soumettre des problèmes pour signaler des bogues ou suggérer des améliorations, ainsi que soumettre vos propres demandes d'extraction pour soumettre vos propres correctifs et ajouts.
Nous vous recommandons de discuter avec l'équipe via Gitter avant de soumettre la demande d'extraction pour éviter de doubler un correctif déjà en attente ou susceptible d'être écrasé par une modification à venir.
Pour utiliser la version git de Gantry, vous devez d'abord installer les dépendances du compositeur. Pour ce faire, exécutez :
bin/composer-install
Après cela, vous devez créer correctement un lien symbolique entre Gantry et votre installation CMS.
Dans notre environnement de développement, nous utilisons Gulp pour regrouper JavaScript et compiler SCSS avec la capacité de watch
afin que toute modification apportée aux fichiers cibles déclenche automatiquement la recompilation.
Si vous souhaitez configurer cela dans votre propre environnement de développement, vous pouvez le faire en suivant ces instructions simples.
Notez que pour que cela fonctionne, vous devez disposer des sources de Gantry 5 et non d'un package. Vous pouvez soit le cloner , soit télécharger la source depuis GitHub.
La première chose dont vous avez besoin est Node / NPM
. Si vous ne les avez pas déjà, vous pouvez récupérer le programme d'installation de votre système d'exploitation sur https://nodejs.org/download/.
L'étape suivante consiste à installer toutes les dépendances du module JS. Pour cela, assurez-vous d'être à la racine du projet Gantry 5, et exécutez la commande npm install
.
Une fois cela fait, vous pouvez installer Gulp . Nous vous recommandons d'installer Gulp globalement afin que vous puissiez utiliser la commande à partir de n'importe quel dossier. Voici la commande pour ce faire : sudo npm install gulp --global
Gantry propose différents ensembles de fichiers JS et CSS qui peuvent être recompilés à partir de la racine. La première fois que vous démarrez Gantry, ou si jamais vous avez besoin de réinitialiser et de réinstaller tous les modules, vous pouvez exécuter la commande npm run build-assets
. Cette opération supprimera tous les dossiers node_modules
et réexécutera npm install
dans tous les dossiers du projet. Cela prendra du temps.
Une méthode alternative qui ne supprimera pas tous les dossiers node_modules
consiste à utiliser gulp -up
.
Avec la commande
-up
, vous pouvez également utiliser-update
,--update
,-up
,--up
,-install
,--install
,-inst
,--inst
,-go
,--go
,-deps
,--deps
. Ce qui est le plus facile à retenir pour vous. Le code comprendra tout seul s'il doit être installé pour la première fois ou simplement mettre à jour les modules de nœuds.Notez que cela peut prendre quelques instants.
À ce stade, vous disposez de tout ce dont vous avez besoin pour exécuter Gulp. Tapez simplement la commande gulp
et vous devriez voir le CSS et le JS compilés.
Nous proposons également quelques tâches pratiques :
$ gulp
/ $ gulp all
: Compile tous les CSS et JS du projet.$ gulp watch
: Démarre les compilateurs en mode watch
. Toute modification appliquée aux fichiers JS ou SCSS ciblés déclenchera une recompilation automatique.$ gulp watch --css
/ $ gulp watch --js
: Démarre les compilateurs en mode watch
et écoute uniquement les modifications SCSS ou JS . Utile si vous vous concentrez uniquement sur l’un et pas sur l’autre.$ gulp css
/ $ gulp js
: Compile tous les fichiers CSS ou JS, au cas où vous ne travailleriez que sur l'un et pas sur l'autre.$ gulp —prod
: Compile tous les CSS et JS en mode production. Les fichiers compilés n'auront pas de mappage source et seront compressés (cela prend généralement un peu plus de temps que le mode normal). Le fichier JSON de Google Fonts peut être généré en suivant le guide sur https://developers.google.com/fonts/docs/developer_api
ou simplement en utilisant https://www.googleapis.com/webfonts/v1/webfonts?key=YOUR-API-KEY
-URL https://www.googleapis.com/webfonts/v1/webfonts?key=YOUR-API-KEY
. Vous devez activer l'utilisation de l'API Google Fonts et fournir votre clé API à la place de YOUR-API-KEY
.
Gantry Framework v5 ou version ultérieure est sous licence sous un système de double licence (MIT ou GPL version 2 ou version ultérieure). Cela signifie que vous êtes libre de choisir la licence (MIT ou GPL version 2 ou version ultérieure) adaptée à vos besoins.
Plus de détails |
---|