You can import or download a zip archive of a help center theme, containing templates, JavaScript, CSS, and assets.
Importing a help center theme
You can import a zip archive of a help center theme, containing templates, JavaScript, CSS, and assets. You can have a maximum of 10 themes in total in Guide.
If you want to import a theme from GitHub, see Setting up the GitHub integration with your Guide theme.
To import a theme into your help center
- In Guide, click the Customize design icon (
) in the sidebar.
The Themes page opens.
- Click Add theme in the upper-right corner.
- Click Import theme.
- Select your theme.
The theme should be in a compressed file with a file name of 30 characters or fewer.
The theme is imported and appears on your Themes page.
Downloading a help center theme
You can download help center themes that you have code access to as a zip archive of templates, JavaScript, CSS, and assets. This enables you to work on it locally, with your own development tools, and check it into version control. To make iterative changes to your theme, see Previewing theme changes locally.
Downloading your theme is the only way to access the manifest.json file for the theme. The manifest file enables you to customize the theme's branding settings, including colors, fonts, and images, see the Customizing the Settings panel.
To download an existing help center theme
- In Guide, click the Customize design icon (
) in the sidebar.
The Themes page opens.
- On the theme you want to download, click the options menu (
), then select Download.
The theme is downloaded to your system in a zipped file.
Help center theme files
You can use the Themes page in Guide admin to download the latest version of the Copenhagen theme. When you download the Copenhagen theme, a zip file containing the Copenhagen theme package is copied to your download folder. This package includes all mandatory files and folders and all optional files contained in the supported folders.
Optional files are files developed to support a custom theme (not available on Suite Team). Custom themes are created when you modify the theme by editing the page templates, CSS, or Javascript, or when you add optional files to a theme. Optional files developed to support a custom theme must be in the related supported folder (templates/article_pages, templates/category_pages, templates/custom_pages, or templates/section_pages) in order to be functional and downloaded with the rest of the theme.
If the theme that you are downloading contains files that are not recognized as one of these files or does not fit into the supported folder structure, they will be stripped from the theme before download. As a result, you will not see them in your zipped theme file.
The following image shows the download folder when the Copenhagen theme package is unzipped. In this example, the article_pages folder is expanded to show an example of the custom article page template file (article_page_template.hbs). The translations folder is expanded to show a partial selection of contents.
7 comments
Andrea Rochira
Hi there,
I downloaded our default theme (Copenaghen), made one single change to the manifest.json file to use API version 2 instead of 1 as explained here (in order to support the templating API v2 and enable the new features), but when I imported the theme back into Help Center Guide, I was presented with 16 errors found in 9 different files within the "templates" folder, how do I go on from there? (opening every single template file and remove the troubling entry?)
I'm including a screenshot below to give a better idea:
0
Dwight Bussman
Andrea Rochira - I recommend that you contact our support team for help with this.
0
Debbie
I am trying to export a theme from one brand so I can use it in another. I have searched for "export theme" and it points to this article but I do not see anything about exporting it. I'm not trying to export content; just the theme we have customized. How do I do that?
0
Dave Dyson
0
Niloufar Lamei
Hi Andrea Rochira,
I followed the steps provided here and only changed the one line (api_version=2). I also did the following:
Were you able to import your theme back?
Thanks,
Niloufar
0
Shaun Luong
There is no "Download" option for my Aarhus (Pro) theme. They know about this and say it's Zendesk's issue to fix. There is a "Download" option for my Copenhagen theme. I am on Zendesk Suite Growth. How do I download my Aarhus theme?
0
Viktor Osetrov
"Aarhus" theme has a "Standard" licence. Unfortunately, Standard licenses don't provide access to the source code and only allow preconfigured settings. If you wish to download your theme - please take a look at the different Themes Marketplace with a Developer licence.
Please notice that:
Developer license: Provides a pre-built theme with access to the theme code, meaning you can customize the theme to your needs. Once you customize a theme it becomes a custom theme and you can no longer download updates to it. However, if you make changes to a copy of the theme, the original version can still receive updates. You can upgrade a standard license to a developer license on the theme settings page.
For more info please follow - Using Guide themes from the Zendesk Marketplace
Hope it helps
0