Skip to content

postmanlabs/postman-zendesk-support-theme

Repository files navigation

Postman logo

Postman Zendesk Support Center

Postman Support Center theme support for Zendesk v2 API. The post-zen theme consists of a set of templates, styles, a Javascript file used mainly for interactions and an assets folder. The theme is managed by the Postman Marketing Engineering Team.

Project structure

When importing a theme to Zendesk Guide it will mainly look for the following files and folders:

Styles

The styles that the Postman Support Center use in the theme are in the style.css file in the root folder.

Assets

Add assets as images and files to the assets/ folder and use them in your CSS and templates. The assets will be uploaded to Zendesk CDN (theme.zdassets.com). You can read more about assets here.

Templates

For markup Zendesk Guide uses Handlebars and each template is stored in the templates/ folder.

Manifest file

The manifest.json contains theme metadata and allows you to define a group of settings for your theme that can then be changed via the UI in theming center. You can read more about the manifest file here.

Settings folder

If you have a type variable of file, you need to provide a default file for that variable in the settings/ folder. This file will be used on the settings panel by default and users can upload a different file if they like. For example, if you'd like to have a variable for the background image of a section, the variable in your manifest file would look something like this:

{
  ...
  "settings": [{
    "label": "Images",
    "variables": [{
      "identifier": "background_image",
      "type": "file",
      "description": "background image description",
      "label": "background image label",
    }]
  }]
}

And this would look for a file inside the settings/ folder named background_image.

Develop

Deploy

To deploy to production, we use the Zendesk GitHub integration.

License

Apache License 2.0

About

Zendesk v2 API theme support for Postman Support Center

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published