The Copenhagen theme is the default Zendesk Guide theme. It is designed to be responsive and accessible. Learn more about customizing Zendesk Guide here.
The Copenhagen theme for Help Center consists of:
This is the latest version of the Copenhagen theme available for Guide. It is possible to use this repository as a starting point to build your own custom theme. You can fork this repository as you see fit. You can use your favorite IDE to develop themes and preview your changes locally in a web browser using ZCLI. For details, read the zcli themes documentation.
Once you have forked this repository you can feel free to edit templates, CSS, JavaScript and manage assets.
The manifest 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.
If you have a variable of type 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.
Ex.
If you would 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 for X section",
"label": "Background image",
}]
}]
}And this would look for a file inside the settings folder named: background_image
You can add assets to the asset folder and use them in your CSS, JavaScript and templates. You can read more about assets here
After you have customized your theme you can download the repository as a zip file and import it into Theming Center.
You can follow the documentation for importing here.
You can also import directly from GitHub - learn more here.
The theme includes all the templates that are used for a Help Center that has all the features available. List of templates in the theme:
- Article page
- Category page
- Community post list page
- Community post page
- Community topic list page
- Community topic page
- Contributions page
- Document head
- Error page
- Footer
- Header
- Home page
- New community post page
- New request page
- Requests page
- Search results page
- Section page
- Subscriptions page
- User profile page
You can add up to 10 optional templates for:
- Article page
- Category page
- Section page
You do this by creating files under the folders templates/article_pages, templates/category_pages or templates/section_pages.
Learn more here.
We use Rollup to compile the JS and CSS files that are used in the theme - style.css and script.js. Do not edit these directly as they'll be regenerated during release.
To get started:
$ yarn install
$ yarn startThis will compile all the source code in src and styles and watch for changes. It will also start preview.
Notes:
- We intentionally do not use babel so we can get a clean bundle output. Make sure to only use widely supported ecmascript features (ES2015).
- Both
style.cssandscript.jsare ignored as they'll be regenerated during release. Do not edit these directly.- If you do want to test your changes by importing the branch in Theming Center, you'll need to manually add and commit these files, e.g.
git add -f script.js style.css
- If you do want to test your changes by importing the branch in Theming Center, you'll need to manually add and commit these files, e.g.
- Preview requires login so make sure to first run
yarn zcli login -iif you haven't done that before.
The Copenhagen theme doesn't have any assets, but you can add assets to your theme by placing them in the assets folder.
We use a custom node script that runs lighthouse for automated accessibility testing.
There are two ways of running the script:
- Development mode - it runs the accessibility audits on the local theme preview, on a specific account. It requires
zat theme previewto be running; - CI mode - it runs the accessibility audits on the live theme of a specific account.
Depending on the scope of testing, some manual testing might be needed in addition to the above. Tools like axe DevTools, screen readers e.g. VoiceOver, contrast checkers etc. can assist such testing.
To run the accessibility audits while changing the theme, one must first preview the changes on a specific account and then run the audits on that preview. To do so:
- Create a
.zatfile in the root folder (see example);- Specify the account/subdomain to preview the theme;
- Fill
usernameandpasswordwith the credentials of an admin user; - Specify which
urlsto test (if left empty, the script will test all urls);
- Preview the local changes by running the theme preview command:
zat theme preview- In a separate console install node modules:
yarn install- Then run the accessibility audits in development mode:
yarn test-a11y -dTo run the accessibility audits on the live theme of a specific account, one must:
- Install node modules:
yarn install- Set
end_user_email,end_user_password,subdomainandurlsas environment variables and run the accessibility audits in CI mode i.e.:
end_user_email=<EMAIL> \
end_user_password=<PASSWORD> \
subdomain=<SUBDOMAIN> \
urls="
https://<SUBDOMAIN>.zendesk.com/hc/en-us/
https://<SUBDOMAIN>.zendesk.com/hc/en-us/requests/new
https://<SUBDOMAIN>.zendesk.com/hc/en-us/requests" \
yarn test-a11yIf there is a known accessibility issue that should be ignored or can't be fixed right away, one may add a new entry to the ignore list in the script's configuration object. This will turn the accessibility issue into a warning instead of erroring.
The entry should include:
- the audit id;
- a
pathas a url pattern string; - a
selectoras a string.
For example:
custom: {
ignore: {
tabindex: [
{
path: "*",
selector: "body > a.skip-navigation",
},
],
aria-allowed-attr: [
{
path: "/hc/:locale/profiles/:id",
selector: "body > div.profile-info"
}
]
},
},In this example, errors for the audit tabindex with the selector body > a.skip-navigation will be reported as warnings in all pages (*). The same will happen for the audit aria-allowed-attr with the selector body > div.profile-info, but only for the user profile page /hc/:locale/profiles/:id.
Please keep in mind that this should only be used when strictly necessarity. Accessibility should be a focus and a priority when making changes to the theme.
Pull requests are welcome on GitHub at https://github.com/zendesk/copenhagen_theme. Please mention @zendesk/vikings when creating a pull request.
We use conventional commits to improve readability of the project history and to automate the release process. The commit message should therefore respect the following format:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
- type: describes the category of the change. See supported types.
- scope: (optional) describes what is affected by the change
- subject: a small description of the change
- body: (optional) additional contextual information about the change
- footer: (optional) adds external links, issue references and other meta-information
i.e.:
chore: automate release
fix(styles): fix button padding
feat(script): add auto focus to fields with errors
We use husky and commitlint to validate messages when commiting.
We use Github actions together with semantic-release to release a new version of the theme once a PR gets merged. On each merge, semantic-release analyses the commit messages and infers a semantic version bump. It then creates a git tag, updates the manifest version and generates the corresponding changelog.
The list bellow describes the supported commit types and their effect in the release and changelog.
| Type | Description | Release | Changelog |
|---|---|---|---|
| build | Changes that affect the build system or external dependencies | - | - |
| chore | Other changes that don't modify the source code | - | - |
| ci | Changes to our CI configuration files and scripts | - | - |
| docs | Documentation only changes | - | - |
| feat | A new feature | minor | Features |
| fix | A bug fix | patch | Bug Fixes |
| perf | A code change that improves performance | patch | Performance Improvements |
| refactor | A code change that neither fixes a bug nor adds a feature | - | - |
| revert | Reverts a previous commit | patch | Reverts |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | - | - |
| test | Adding missing tests or correcting existing tests | - | - |
Commits that add a breaking change should include BREAKING CHANGE in the body or footer of the commit message.
i.e.:
feat: update theme to use theming api v2
BREAKING CHANGE: theme is now relying on functionality that is exclusive to the theming api v2
This will then generate a major release and add a BREAKING CHANGES section in the changelog.
Bug reports must be submitted through Zendesk's standard support channels: https://www.zendesk.com/contact/