{"id":23275486,"url":"https://github.com/zeroheight-demos/zh-releases","last_synced_at":"2026-04-29T01:34:18.768Z","repository":{"id":268697163,"uuid":"895107106","full_name":"zeroheight-demos/zh-releases","owner":"zeroheight-demos","description":"Embed your design system release notes ✨anywhere✨","archived":false,"fork":false,"pushed_at":"2024-12-18T10:41:38.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T11:32:30.944Z","etag":null,"topics":["customelement","customelements","designsystem","designsystems","webcomponent","webcomponents","zeroheight"],"latest_commit_sha":null,"homepage":"https://zeroheight-demos.github.io/zh-releases/demo.html","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zeroheight-demos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-27T15:14:57.000Z","updated_at":"2024-12-18T10:43:27.000Z","dependencies_parsed_at":"2024-12-18T11:41:33.981Z","dependency_job_id":"0dff6439-4e4d-424a-b767-c1b56dad66d0","html_url":"https://github.com/zeroheight-demos/zh-releases","commit_stats":null,"previous_names":["zeroheight-demos/zh-releases"],"tags_count":0,"template":false,"template_full_name":"daviddarnes/component-template","purl":"pkg:github/zeroheight-demos/zh-releases","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeroheight-demos%2Fzh-releases","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeroheight-demos%2Fzh-releases/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeroheight-demos%2Fzh-releases/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeroheight-demos%2Fzh-releases/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeroheight-demos","download_url":"https://codeload.github.com/zeroheight-demos/zh-releases/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeroheight-demos%2Fzh-releases/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32407164,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T19:38:08.556Z","status":"ssl_error","status_checked_at":"2026-04-28T19:37:55.688Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["customelement","customelements","designsystem","designsystems","webcomponent","webcomponents","zeroheight"],"created_at":"2024-12-19T21:14:22.797Z","updated_at":"2026-04-29T01:34:18.751Z","avatar_url":"https://github.com/zeroheight-demos.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `zh-releases`\n\nA Web Component for embedding design systems releases on any page.\n\n**[Demo](https://zeroheight-demos.github.io/zh-releases/demo.html)** | **[Further reading](https://zeroheight.com/blog/zeroheight-api-tutorial-add-design-system-releases-to-any-website)**\n\n## Examples\n\nGeneral usage example:\n\n```html\n\u003czh-releases\u003e\u003c/zh-releases\u003e\n\n\u003cscript\u003e\n  const zhAPI = {\n    key: \"zhat_VuWPCQcW78XRw4ufLt3FTdJ8AIyGz5ff-q6jGLcG\",\n    client: \"zhci_5rSLVtpSHA28sk9Li2TpGRIVtSejhfIIRbRBkBgC\",\n    styleguide: 114183,\n  };\n\u003c/script\u003e\n\n\u003cscript type=\"module\" src=\"zh-releases.js\"\u003e\u003c/script\u003e\n```\n\nExample using a custom template:\n\n```html\n\u003ctemplate id=\"custom-template\"\u003e\n  \u003col\u003e\n    \u003cli data-key=\"release\"\u003e\n      \u003ca data-key=\"release_url\"\u003e\u003cspan data-key=\"name\"\u003e\u003c/span\u003e\u003c/a\u003e\n    \u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/template\u003e\n\n\u003czh-releases template=\"custom-template\"\u003e\u003c/zh-releases\u003e\n\n\u003cscript\u003e\n  const zhAPI = {\n    key: \"zhat_VuWPCQcW78XRw4ufLt3FTdJ8AIyGz5ff-q6jGLcG\",\n    client: \"zhci_5rSLVtpSHA28sk9Li2TpGRIVtSejhfIIRbRBkBgC\",\n    styleguide: 114183,\n  };\n\u003c/script\u003e\n\n\u003cscript type=\"module\" src=\"zh-releases.js\"\u003e\u003c/script\u003e\n```\n\n## Features\n\nThis Web Component allows you to:\n\n- Render a full history of your design systems releases\n- Link to versions of your styleguide within the release history\n- Customise the look of the releases with a custom template\n\n## Installation\n\nYou have a few options (choose one of these):\n\n1. ~Install via [npm](https://www.npmjs.com/package/@zeroheight/zh-releases): `npm install @zeroheight/zh-releases`~\n1. [Download the source manually from GitHub](https://github.com/zeroheight-demos/zh-releases/releases) into your project.\n1. ~Skip this step and use the script directly via a 3rd party CDN (not recommended for production use)~\n\nAfter choosing one of these options you'll need to attain an API Key, Access Token and the ID of your styleguide from your zeroheight account. For more information check out our resources guide. These credentials can be applied to the component as a global object variable like so:\n\n```js\nconst zhAPI = {\n  key: \"zhat_VuWPCQcW78XRw4ufLt3FTdJ8AIyGz5ff-q6jGLcG\",\n  client: \"zhci_5rSLVtpSHA28sk9Li2TpGRIVtSejhfIIRbRBkBgC\",\n  styleguide: 114183,\n};\n```\n\n### Usage\n\nMake sure you include the `\u003cscript\u003e` in your project (choose one of these):\n\n```html\n\u003c!-- Host yourself --\u003e\n\u003cscript\u003e\n  const zhAPI = {\n    key: \"zhat_VuWPCQcW78XRw4ufLt3FTdJ8AIyGz5ff-q6jGLcG\",\n    client: \"zhci_5rSLVtpSHA28sk9Li2TpGRIVtSejhfIIRbRBkBgC\",\n    styleguide: 114183,\n  };\n\u003c/script\u003e\n\n\u003cscript type=\"module\" src=\"zh-releases.js\"\u003e\u003c/script\u003e\n```\n\n## Credit\n\nWith thanks to the following people:\n\n- [Zach Leatherman](https://zachleat.com) for inspiring this [Web Component repo template](https://github.com/daviddarnes/component-template)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeroheight-demos%2Fzh-releases","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeroheight-demos%2Fzh-releases","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeroheight-demos%2Fzh-releases/lists"}