Puede trabajar con un tema localmente en su editor de código preferido o previsualizar los cambios en vivo en un navegador web. No es necesario que cargue los archivos en Guide cada vez que desee hacer una vista previa de los cambios. Un proceso que se ejecuta en segundo plano en el equipo carga los cambios automáticamente cada vez que se guarda un archivo localmente.
Ejemplo:
Temas que se tratan en este artículo:
Configurar una vista previa local del tema
La configuración de una vista previa local del tema consiste en descargar los archivos del tema, activar el acceso de la API en la cuenta e instalar la interfaz de línea de comando de Zendesk (ZCLI) en el equipo. La ZCLI permite hacer una vista previa local del tema.
Para configurar una vista previa local del tema
- Descargue los archivos del tema de Guide, descomprímalos y colóquelos en una carpeta de trabajo.
Consulte Descargar un tema del centro de ayuda.
- Si aún no lo ha hecho, active el acceso de la API en su cuenta de Zendesk.
En el Centro de administración, haga clic en
Aplicaciones e integraciones en la barra lateral y luego seleccione API > API de Zendesk. - Instale la interfaz de línea de comando de Zendesk. Consulte Installing and updating ZCLI (Instalar y actualizar ZCLI) en la documentación para desarrolladores de Zendesk.
Iniciar una vista previa local del tema
La vista previa local del tema se debe iniciar antes de comenzar a trabajar con los archivos del tema en el equipo.
Para iniciar una vista previa local del tema
- En la terminal de la línea de comando del equipo, vaya a la carpeta que contiene los archivos del tema descargados y descomprimidos. Ejemplo:
cd guide_themes/newlook_theme - Inicie sesión en la cuenta de Zendesk donde se descargó el tema.
zcli login -iCuando se le indique, ingrese su subdominio, correo electrónico y contraseña:
Utilice el subdominio de Zendesk estándar de su cuenta para iniciar sesión. No use ningún subdominio con mapeo de host.
Si utiliza el inicio de sesión único (SSO) para iniciar sesión en Zendesk, puede iniciar sesión usando un token de API. Ingrese su_correo electrónico/token como su nombre de usuario, donde "/token" es la cadena "/token” en sí. Utilice el token de API como su contraseña. Ejemplo:Email: jdoe@example.com/token Password: e8Pvy0pvGzE8meUQxWgjIYkjr - Inicie el proceso en segundo plano para la vista previa local:
zcli themes:previewEste comando ZCLI inicia la vista previa local y carga el tema local en modo Vista previa en el centro de ayuda. Los cambios que se realicen en los archivos localmente se verán reflejados en el tema en el modo Vista previa.
- Copie el URL "Ready" y péguelo en un navegador web, como Chrome o Firefox.
El navegador tiene que permitir contenido mixto de HTTP y HTTPS. Safari no admite contenido mixto y no le permitirá previsualizar los temas localmente.
El URL "Ready" es así: https://susubdominio.zendesk.com/hc/admin/local_preview/start.
Si desea más información sobre el comando ZCLI de vista previa, consulte zcli themes en GitHub.
Previsualizar los cambios
Una vez que ZCLI cargue el tema en modo Vista previa en su centro de ayuda, podrá trabajar con los archivos del tema localmente en su editor de código preferido y previsualizar los cambios en el navegador. Trabaje de manera iterativa para crear y probar el tema. Por ejemplo, haga algunos cambios en un archivo, guarde el archivo y luego verifique los cambios en el navegador. Corrija cualquier problema antes de hacer cambios adicionales.
Para previsualizar los cambios
- Guarde el archivo o los archivos editados en el editor de código.
- Verifique los resultados en el tema en modo Vista previa en el navegador.
El tema se vuelve a cargar automáticamente en el navegador cuando el archivo se guarda localmente. No es necesario volver a cargar la página.
Hay una opción de ZCLI para desactivar la opción para volver a cargar automáticamente. Consulte zcli themes en GitHub.
Al final del día, puede detener el modo Vista previa usando uno de los siguientes métodos:
- En la sesión de la terminal que ejecuta ZCLI, presione Ctrl+C.
- Abra https://subdominio.zendesk.com/hc/admin/local_preview/stop en el navegador, con su subdominio real en el URL.
- En la parte superior de la página de vista previa del tema del navegador, haga clic en el vínculo Cerrar vista previa.