Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 3.18 KB

README.md

File metadata and controls

91 lines (61 loc) · 3.18 KB

Copenhagen Theme by Zendesk - Uniswap Support Site

‼️Disclaimer: To allow content editors of the Uniswap Support website to edit Handlebars (.hbs) code from the Uniswap lab's Zendesk Guide theme editor interface, we will treat the Handlebars files from the active Zendesk theme on the web as the source of truth.

Please download the Handlebars files from the currently active Zendesk theme and use those files when editing code in this repository.

A customized Zendesk Guide theme 'Copenhagen' for Uniswap's support site

Stack

  • Framework: React
  • Language: TypeScript
  • Styling: Tailwind CSS
  • CMS: Zendesk Guide

Zendesk Theme Customization

For detailed information on customizing the Zendesk theme, refer to the Zendesk Theme Documentation.

Local Development

  1. Install Dependencies
yarn install
  1. Login to Zendesk Account
zcli login -i
  • zcli is a command-line interface tool used to interact with Zendesk products, allowing you to manage and deploy themes. For more information, visit the zcli documentation.
    • To login to zcli, use Uniswap team's Zendesk account credentials to login
      • Subdomain: uniswaplabs
      • API token: use existing one if you have one saved or create a new one from Zendesk
  • Access the Zendesk login page via Browser to preview the page
  1. Start Development Server
yarn start

This will:

  • Compile TypeScript and React components
  • Watch for changes
  • Start preview server

Project Structure

src/
├── modules/          # React components
├── styles/          # Tailwind & SCSS styles(use `main.css` to override existing Zendesk theme styles)
└── templates/       # Handlebars templates

Key Features

  • React Components: Built using Zendesk Garden UI library
  • TypeScript: Type-safe development
  • Tailwind CSS: Utility-first styling
  • Dark/Light Mode: Theme switching support

Deployment

  1. Push changes to the master branch.
  2. Run the command below to upload the theme to the production Zendesk Guide site.
node ./bin/theme-upload.js

CI pipeline for automated deployment is not available since theme related commands cannot use Zendesk environment variables for zcli(Mentioned here)

Hard-coded values

These components' text/link elements are hardcoded on code, so codebase owners should assist content editors when they need to change these items.

  • Hero title texts(in templates/home_page.hbs)
  • Colored box block(4 colored boxes right below the hero)(in templates/home_page.hbs)
  • Footer link items(in templates/footer.hbs)

Support

For bug reports and feature requests:

  1. Internal team: Create an issue in the repository
  2. External users: Contact Zendesk support at https://www.zendesk.com/contact/