Developer Guide to Boris Customization
Developer Guide to Boris Customization
Welcome to the advanced customization guide for the Boris theme by Torango.io, specifically designed for Zendesk help centers. This guide aims to provide developers with the knowledge to tailor the Boris theme to fit specific needs and enhance the user experience.
Getting Started
Before diving into customization, ensure you have the following:
- Access to your Zendesk Guide admin panel.
- Familiarity with HTML, CSS, and JavaScript.
- Basic understanding of Zendesk's templating language, Curlybars.
Understanding Boris's File Structure
The Boris theme comprises several key files and directories:
- manifest.json - Defines the theme settings and options.
- style.css - Contains all the custom styles.
- script.js - Holds the JavaScript used for interactive elements.
- templates - A directory with all the HTML templates.
Customizing CSS
To modify the look and feel of the Boris theme:
- Locate the
style.css
file in your theme's directory. - Add or override existing CSS styles. For instance, to change the background color, you might add:
body { background-color: #f4f4f4; }
- Preview changes in the Zendesk Guide theme editor before publishing.
Integrating JavaScript
Enhancing functionality with JavaScript:
- Navigate to the
script.js
file. - Add new functions or modify the existing ones. For example, to add a simple alert on page load:
window.onload = function() { alert('Welcome to our Help Center!'); };
- Test your scripts thoroughly to ensure they do not interfere with the default Zendesk functions.
Working with Curlybars Templates
Boris templates use Curlybars, Zendesk’s templating language. It allows dynamic content loading and customization:
- Access the
templates
directory. - Choose the template you wish to modify. For instance, for the Home Page, you might be looking at
home_page.hbs
. - Use Curlybars logic to add or modify dynamic elements. For example:
{{#is user 'logged-in'}} <p>Welcome back, {{user.name}}!</p> {{/is}}
- Preview and test changes extensively in different scenarios to ensure proper functionality.
Testing and Deployment
Always test your changes comprehensively:
- Use Zendesk’s preview mode to review changes in real-time.
- Ensure responsiveness and compatibility across all devices and browsers.
- Once satisfied, deploy the changes by publishing the theme in your Zendesk Guide settings.
Comments
0 comments
Please sign in to leave a comment.