When you are working on themes for your Help Center, there are some number and size limitations that you should be aware of. This article details the maximum limits for themes, associated files, and assets in Guide.
The theming limits in this article apply to functionality in Guide Professional and Enterprise, with the exception of number of themes, which applies to all plans.
Theming size limits
The following table shows the maximum limits for themes, associated files, and assets in Guide.
| Item | Maximum |
|---|---|
| Total number of themes | 10 |
| Individual theme size | 30MB |
| Total theme assets size | 25MB |
| Individual theme asset size | 5MB |
| Individual theme template size | 300KB |
| Total number of settings in manifest.json | 100 |
| Total number of options in a list type setting | 20 |
Allowable file types for theme assets
The following table shows the file types that are allowed as theme assets. The allowable files types for assets are limited to the file types used in the theming of a Help Center.
| Asset type | File types allowed |
|---|---|
| Images | jpg, png, gif, svg, webp, tiff, bmp |
| Fonts | woff2, woff, eot, otf |
| Text files | js, css, html, json, txt, xml |
| Other | mp4, swf, wav, ogg |
Rich content files types, such as Microsoft PowerPoint, Microsoft Word and PDFs, can be article attachments but cannot be theme assets.
Why are there limits
- For security purposes it’s important to vet the types of files that customers are allowed to upload so that we don’t receive malicious files.
- To prevent misuse or abuse vectors, it's important to limit the total size of files.
- For performance reasons, it’s important to serve, save, import and export files quickly for customers.
For these reasons, we enforce the theme limitations described in this article in Guide.
About migrated themes and limits
On November 14, 2017 we introduced a new theming experience in Guide. When you migrate from the previous theming experience, some new restrictions will be applied to your themes. During the migration process, we suspend some file type and file size limitations to allow you to move your theme and assets to the new theming experience where they will be easier to work with.
For example, if you have a number of PDFs or other files that are no longer supported in theme assets, you will be able to migrate your theme. From there you can export that theme to retrieve all of these files easily. However, you won’t be able to duplicate or re-import that theme until the unsupported files are removed from the theme.
About article attachment limits
Article attachments are governed by their own restrictions and not theming restrictions.
The article attachment limit is 20 MB. See Creating and editing articles in the knowledge base.
Comments
0 comments
Please sign in to leave a comment.