英语(美国)
  1. 亚博Zendesk帮助
  2. 指南
  3. 帮助中心使用指南
  4. 使用主题和自定义帮助中心

本地预览主题更改

瑞安·麦格罗
  • 编辑
亚博Zendesk产品经理

我的计划是什么?

套件成长，专业，企业和企业Plus专业企业计划

您可以从指南中导出主题文件，并在您首选的文本编辑器中脱机处理这些文件。为了避免每次想要预览更改时都将文件压缩并导入Guide，您可以使用Zendesk Apps Tools (ZAT)在web浏览器中本地预览每个更改。亚博要预览更改，您可以将主题文件保存在桌面编辑器中，然后在浏览器中刷新页面。例子:

ZAT是一个开发者工具的集合，包括Sinatra，一个在你的电脑上本地运行的web服务器。启动预览模式后，进程在后台运行。

注意:的亚博Zendesk命令行接口(ZCLI) 取代ZAT的应用程序开发，但不支持预览Zendesk指南主题。亚博

本文涉及的主题:

设置本地主题预览

要安装和使用ZAT，您需要启用API访问并设置本地开发环境。

设置本地主题预览

  1. 如果还没有这样做，请在您的Zendesk Support帐户中启用API访问亚博管理>渠道>API．
  2. 安装扎-。看到安装和使用ZATZendesk亚博开发人员文档中。然后回到这里。
  3. 通过在计算机终端运行以下命令更新ZAT:
    Gem update 亚博zendesk_apps_tools

启动本地主题预览

在开始处理计算机上的主题文件之前，请先启动本地主题预览。

启动本地主题预览

  1. 在计算机终端中，导航到包含导出和解压缩主题文件的文件夹。例子:
    cd guide_themes / newlook_theme
  2. 执行如下命令:
    Zat主题预览
  3. 在提示下，输入您的Zendesk子域，以及用于登录Ze亚博ndesk Guide的电子邮件和密码。

    如果使用单点登录(SSO)登录Guide，则可以使用API令牌登录。看到API的令牌在REST API文档中。当ZAT提示登录时，输入{your_email} /令牌对于您的用户名，其中“/token”是实际字符串“/token”。使用API令牌作为密码。例子:
    输入您的用户名:jdo @example.com/token输入您的密码:e8Pvy0pvGzE8meUQxWgjIYkjr

    登录成功后，预览模式启动并在后台运行:

  4. 复制输出中的“Ready”URL并将其粘贴到web浏览器(如Chrome或Firefox)中。浏览器必须允许混合HTTP和HTTPS内容。Safari不支持混合内容，也不允许你在本地预览主题。

    在本例中，“Ready”URL为https://z3n-example.亚博zendesk.com/hc/admin/local_preview/start．

    URL应该加载主题预览。

预览更改

启动主题预览模式后，您可以在文本编辑器中本地处理主题文件。反复开发和测试你的主题。例如，对JavaScript进行一些更改，保存更改，然后刷新浏览器页面以测试更改。

预览更改

  1. 将编辑后的文件保存在文本编辑器中。
  2. 在浏览器中刷新页面。

完成后，您可以使用以下方法之一停止预览模式:

  • 在运行ZAT的终端会话中，按Ctrl + C．
  • 在浏览器主题预览页的顶部，单击关闭预览链接。
    回到顶端

    32个评论

    • Pasquale Errico

      我有一个问题，我想，与肝脏负荷和ZAT。

      如果启动Zat主题预览我的页面是未格式化和缓慢的，控制台显示如下:

      还有其他一些。

      我在Chrome上允许不安全的内容，也测试了zat主题预览-没有肝脏负荷，但不工作。

      我必须在我们的指南上使用在线数据，但这似乎是不可能的!

      有解决这个问题的方法吗?

      非常感谢

      1
    • 格雷格Katechis
      亚博Zendesk开发者倡导

      嗨帕斯夸里!对于这样的问题，我建议直接与我们的宣传团队这样他们就能得到额外的信息。

      1
    • 本

      只是想接触到这里，看看是否有人在尝试在本地主题工作时遇到了ZAT的问题。由于某些原因，它不再拾取模板文件的更改，我不得不关闭并重新运行zat主题预览每次更改。

      我的一个团队也遇到了间歇性的问题，它需要很长时间才能完全启动web服务器，这是双重烦人的。

      1
    • PawełPorombka

      嗨，我一年前也有同样的问题。本地开发的API很糟糕。我为它创建了自定义解决方案，因为我花了2周时间试图使它完全工作。没有机会。服务器连接中断，上传持续出现问题等。我在Gulp中创建了自己的持续部署脚本。它正在起作用，我建议大家也这样做。亚博Zendesk API允许我自己做。

      1
    • 基斯Bottner

      试着设置这个，第一步是一个show stopper，它说

      1. 如果还没有这样做，请在您的Zendesk Support帐户中启用API访问亚博管理>渠道>API．

      然而，当我去管理>通道没有API，也没有办法添加API。在如何配置这个方面有什么变化吗?

      1
    • Cheeny波斯历八月
      亚博Zendesk客户服务

      嗨,基思,

      你可以通过进入Admin(看起来像屏幕左侧的轮子图标)>Channels>API来访问API。如果你仍然不能看到它，你可以向我们的客户支持这样他们就能仔细调查你的账户了

      0
    • 小约书亚

      我启用了主机映射，当我导航到由主题预览生成的URL时，我被重定向到指定的主机映射。当我将域设置为指定的主机映射时，导航到生成的URL仍然会重定向。在使用主机映射时，推荐使用什么方法预览主题?

      0
    • Cheeny波斯历八月
      亚博Zendesk客户服务

      嗨,约书亚,

      当预览你的帮助中心，你也可以去你的指南管理>主题>他们，你想要预览>在预览页面，你可以选择模板和预览角色可以从终端用户更改为管理员

      0
    • 特雷
      • 编辑

      没关系，它现在莫名其妙地起作用了

      奇怪。我星期五发了这条消息，现在不见了。

      我正在设置我的本地Zendesk指南主题，所以我可以做一些改变。亚博我遵循了这里的说明，但是当我执行第4步“复制输出中的“Ready”URL并将其粘贴到浏览器中”时，帮助中心只是重定向到我的主指南页面。我错过什么了吗?

      1
    • Gabriele F。
      亚博Zendesk客户服务
      嗨特雷!正如我从你最后添加到评论中看到的，这现在是自我解决的，这些导致了暂时的故障。我也会将这个设置为已解决状态，如果您遇到其他问题，请随时联系我们，我们将继续排除故障。
      0
    • Arati C

      你好,

      当我使用命令时

      Zat主题预览

      并输入所有细节，服务器启动，但随后立即停止运行错误

      ' start_tcp_server':没有acceptor(端口正在使用或需要root权限)(运行时间错误)

      我能做些什么来修复这个错误?

      感谢任何帮助，因为我是新的Zendesk。亚博

      谢谢,

      Arati

      0
    • 本

      是否有可能在此尝试之前您遇到问题使服务器启动?错误提示该端口已被进程占用。
      您可以在linux上使用此cmd获取端口列表:
      sudo lsof -i -P -n

      如果Zende亚博sk已打开或正在使用，则可以使用此命令终止占用该端口的进程。
      Kill -9 $(lsof -t -i:8080)

      另一种选择是退出并重新登录或重新启动以释放端口。

      2
    • Arati C

      谢谢你，本，在我重启系统后，它成功了。

      接下来，我遇到了类似Trey的问题。即使我使用的是“Ready URL”，我也会被重定向到我的指南的主页，而这个URL是Zendesk网站的。亚博它说它是预览模式，这是正确的方式，就像在截图?但是URL不是我在预览开始时输入的那个。我错过什么了吗?

      谢谢,

      Arati

      0
    • 本
      • 编辑

      当你访问准备好的URL时，它总是重定向回主页，你会看到你在那里看到的横幅。这应该意味着你在预览中是正确的，你所做的编辑现在应该反映出来。

      您可以通过检查脚本资源是否来自本地资源来确认。

      0
    • Tipene休斯
      亚博Zendesk开发者倡导

      嗨Pawel Przysucha，

      谢谢你的帮助!

      如果您从浏览器访问主题预览，其中没有保存您的凭据或您没有登录，预览仍然需要登录，如果这是在您的帐户设置。

      如果你有任何问题，请告诉我!

      Tipene

      0
    • Gizem Candemir

      嗨，帕维沃波伦卡，

      我刚刚读了你的评论:
      “本地开发的API很糟糕。我为它创建了自定义解决方案，因为我花了2周时间试图使它完全工作。没有机会。服务器连接中断，上传持续出现问题等。我在Gulp中创建了自己的持续部署脚本。它正在起作用，我建议大家也这样做。亚博Zendesk API允许我自己完成所有工作。”

      我很好奇你是怎么解决这些问题的。你会写一篇社区文章来解释你是如何创建自定义解决方案的吗?我希望如此!谢谢:)

      或者，如果我们能得到Zendesk关于ZAT主题预览的这些问题的指导，那就太好了。亚博这确实拖慢了我们的发展速度

      0
    • 格雷格Katechis
      亚博Zendesk开发者倡导

      嗨Gizem !您能告诉我您使用的是什么文件系统吗?我们对ZAT使用' listen ' gem，它确实有一些与它所运行的fs相关的限制。在ZAF回购上有一个公开的PR来强制轮询，这可能会解决这个问题，但由于它现在处于维护模式，很难得到推动。我会看看我能做些什么!

      1
    • Gizem Candemir

      嗨,格雷格,

      谢谢你看这个!我的文件系统似乎是“APFS(加密)”。

      我希望你能让公关行动起来，这可以解决预览的问题!

      0
    • 帕特里克•刘易斯
      我遇到了和Ben一样的问题，直到我做出改变，zat主题预览才会工作。从样式表中删除对$assets的所有引用为我修复了这个问题。查看这个zende亚博sk_apps_tools线程https://github.com/亚博zendesk/zendesk_apps_tools/issues/364
      1
    • 拉詹

      你好各位,
      我正在使用Okta登录，如何获得我的密码Zat主题预览？

      0
    • CJ约翰逊

      我在同样的情况下，你可以生成一个API令牌，然后在你的邮件后使用/token来生成预览，拉詹．
      https://support.亚博zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token


      0
    • CJ约翰逊

      由于ZAT不再受支持，本文可以进行全面修改。

      0
    • 布列塔尼曼德尔

      有人能帮我解决这个错误吗?

      警告:在适配器之后设置了意外的中间件。Faraday 1.0将不支持此功能。
      上传失败:服务器响应状态为403
      服务器错误。
      1
    • 格雷格Katechis
      亚博Zendesk开发者倡导

      嗨布列塔尼!通常，这表明您的凭据不正确。如果您使用API令牌，您是否在您的电子邮件地址后面添加了“/token”?如果没有，你是否有更多的信息可以与我们分享，以便我们更好地提供帮助?

      0
    • 布列塔尼曼德尔

      格雷格Katechis-我让它工作，也就是说-预览工具留下了很多需要改进的地方，功能非常差。

      0
    • 詹姆斯Rodewig
      • 编辑
      亚博Zendesk文档团队

      嗨CJ约翰逊，

      谢谢你的帮助。我看到你的评论了:

      由于ZAT不再受支持，本文可以进行全面修改。

      这不是很准确。尽管ZAT处于维护模式，但它仍然受到支持。虽然我们现在鼓励开发者使用ZCLI进行应用开发，但ZCLI目前不支持主题预览。相关的文档]。

      也就是说，我将对本文的其他问题进行审查。再次感谢。我们感谢您的反馈。

      1
    • 拉詹

      你好团队

      由于ZAT处于维护模式，并且在本地预览主题时存在错误。本地主题预览的其他选项是什么，因为ZCLI不支持它?

      答:詹姆斯Rodewig，CJ约翰逊，格雷格Katechis

      2
    • Arno (EMEA合作伙伴)

      有问题的ZAT主题预览突然，一个星期了。仅使用标准端口。阅读更新和相关问题之后，但基于更新，标准端口应该没有任何问题了。由于飞行前请求失败，*.js和*.css文件无法加载，这是意外的。

      有人可以确认你的环境工作良好与zat主题预览?

      如果是这样，我需要弄清楚，我自己的环境出了什么问题。

      0
    • Arno (EMEA合作伙伴)

      这与默认的“ip地址”有关。默认情况下，主题预览/ sinatra在0.0.0.0:4567上监听，如下所示，在返回第一个页面加载的几个文件后，它似乎失败了。之后，在长时间的延迟后，只是空的响应，我在浏览器网络面板中看到失败的预飞行请求。

      == Sinatra (v2.2.3)已经在4567上登台进行开发，并从Thin备份
      2023-02-13 21:22:51 +0200精简web服务器(v1.8.1代号Infinite Smoothie)
      2023-02-13 21:22:51 +0200最大连接数设置为1024
      2023-02-13 21:22:51 +0200收听0.0.0.0:4567， CTRL+C停止

      我不知道这是否在某个时候发生了变化，但是根据Zendesk的说明，在Windows上重新安装了最新的Ubuntu和其他工具，这又是默认地址，并且出现了同样的问题。亚博

      这为我解决了这个问题最后-当开始预览时，将其绑定到本地主机的IP地址:

      Zat主题预览——bind 127.0.0.1

      我不知道，如果这是特定于我的环境，但至少你可以尝试这个，如果遇到类似的问题。

      0
    • 安东尼Chiboucas

      我甚至不能让ZAT在Ubuntu 22上工作:
      https://developer.亚博zendesk.com/documentation/apps/zendesk-app-tools-zat/installing-and-using-zat/

      错误:"无法在/usr/lib/ruby/include/ruby.h中找到ruby的头文件。

      您可能需要为ruby开发安装单独的包
      环境，例如ruby-dev或ruby-devel。”

      只不过这些都不再是有效宝石了。我在这里停了下来。

      0

    请登录留下评论。

    由Zendesk提供支亚博持