Mon édition

Disponible avec les éditions Suite Growth et supérieuresDisponible avec toutes les éditions Guide

Vous pouvez travailler sur un thème dans l’éditeur de code de votre choix en local et afficher un aperçu de vos modifications en direct dans un navigateur Web. Vous n’avez pas à charger les fichiers dans Guide chaque fois que vous voulez voir un aperçu de vos modifications. Un processus qui s’exécute en arrière-plan sur votre ordinateur charge vos modifications pour vous chaque fois que vous enregistrez un fichier en local.

Exemple :

Sujets abordés dans cet article :

  • Configuration de l’aperçu du thème en local
  • Lancement de l’aperçu du thème en local
  • Aperçu des modifications

Configuration de l’aperçu du thème en local

Pour configurer l’aperçu du thème, vous devez télécharger les fichiers du thème, activer l’accès à l’API dans votre compte et installer l’interface de ligne de commande Zendesk (Zendesk Command Line Interface ou ZCLI) sur votre ordinateur. L’interface de ligne de commande Zendesk permet l’aperçu des thèmes en local.

Pour configurer l’aperçu du thème en local

  1. Téléchargez les fichiers du thème depuis Guide et décompressez-les dans un dossier de travail.

    Consultez Téléchargement d’un thème de votre centre d’aide.

  2. Si vous ne l’avez pas déjà fait, activez l’accès à l’API dans votre compte Zendesk.

    Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez API > API Zendesk.

  3. Installez l’interface de ligne de commande Zendesk. Consultez l’article sur l’Installation et l’utilisation de ZCLI dans la documentation pour les développeurs Zendesk.

Lancement de l’aperçu du thème en local

Vous devez lancer l’aperçu du thème en local avant de commencer à travailler sur les fichiers du thème sur votre ordinateur.

Pour lancer l’aperçu du thème en local

  1. Dans le terminal de ligne de commande de votre ordinateur, naviguez jusqu’au dossier contenant les fichiers du thème téléchargés et décompressés. Exemple :
    cd guide_themes/newlook_theme
  2. Connectez-vous au compte dans lequel vous avez téléchargé le thème.
    zcli login -i

    Aux invites, saisissez votre sous-domaine, votre e-mail et votre mot de passe :

    Utilisez le sous-domaine Zendesk standard de votre compte pour vous connecter. N’utilisez pas de sous-domaine avec mappage d’hôte.

    Si vous utilisez la connexion unique pour vous connecter à Zendesk, vous pouvez vous connecter en utilisant un token API. Saisissez {votre_email}/token comme nom d’utilisateur (« /token » étant la chaîne « /token » telle quelle). Utilisez le token API comme mot de passe. Exemple :
    Email: jdoe@example.com/token
Password: e8Pvy0pvGzE8meUQxWgjIYkjr
  3. Lancez le processus d’arrière-plan pour l’aperçu en local :
    zcli themes:preview

    La commande ZCLI lance l’aperçu en local et charge le thème local en mode Aperçu dans votre centre d’aide. Les modifications que vous avez apportées en local sont reflétées dans le thème en mode Aperçu.

  4. Copiez l’URL « Ready » et collez-la dans un navigateur Web, comme Chrome ou Firefox.

    Le navigateur doit autoriser un contenu HTTP et HTTPS mixte. Safari ne prend pas en charge le contenu mixte et ne vous permettra pas d’afficher l’aperçu des thèmes en local.

    L’URL « Ready » ressemble à ce qui suit : https://yoursubdomain.zendesk.com/hc/admin/local_preview/start.

Pour en savoir plus sur la commande d’aperçu ZCLI, consultez zcli themes sur GitHub.

Aperçu des modifications

Une fois que ZCLI a chargé votre thème en mode Aperçu dans votre centre d’aide, vous pouvez travailler sur vos fichiers de thème en local dans l’éditeur de code de votre choix et en afficher l’aperçu dans votre navigateur. Travaillez de façon itérative pour développer et tester votre thème. Par exemple, modifiez un fichier, enregistrez-le, puis enregistrez vos modifications dans votre navigateur. Résolvez tous les problèmes liés à vos modifications avant d’en faire d’autres.

Pour consulter l’aperçu des modifications

  1. Enregistrez le ou les fichiers modifiés dans votre éditeur de code.
  2. Vérifiez les résultats dans le thème en mode Aperçu dans votre navigateur.

Le thème se recharge automatiquement dans votre navigateur quand vous enregistrez un fichier en local. Vous n’avez pas à actualiser la page.

ZCLI vous permet de désactiver les rechargements en direct. Consultez la section sur les thèmes zcli sur GitHub.

Quand vous avez terminé, vous pouvez arrêter le mode Aperçu en utilisant l’une des méthodes suivantes :

  • Dans la session de terminal dans laquelle s’exécute ZCLI, appuyez sur Ctrl + C.
  • Ouvrez https://votre_sousdomaine.zendesk.com/hc/admin/local_preview/stop dans votre navigateur (en remplaçant votre_sousdomaine par votre sous-domaine dans l’URL).
  • En haut de la page d’aperçu du thème du navigateur, cliquez sur le lien Fermer l’aperçu.
Réalisé par Zendesk