{"id":21675924,"url":"https://github.com/helpscout/kiwi","last_synced_at":"2026-04-15T08:34:50.873Z","repository":{"id":34136228,"uuid":"169499819","full_name":"helpscout/kiwi","owner":"helpscout","description":"🥝 Kiwi: Seamless syncing for Design Wikis","archived":false,"fork":false,"pushed_at":"2022-12-08T12:37:00.000Z","size":1437,"stargazers_count":1,"open_issues_count":20,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-12T20:43:06.317Z","etag":null,"topics":["ci","cli","github","github-wiki","nodejs","open-source","sync","wiki"],"latest_commit_sha":null,"homepage":"https://style.helpscout.com","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/helpscout.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}},"created_at":"2019-02-07T00:46:06.000Z","updated_at":"2019-06-18T18:27:45.000Z","dependencies_parsed_at":"2023-01-15T05:00:54.025Z","dependency_job_id":null,"html_url":"https://github.com/helpscout/kiwi","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fkiwi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fkiwi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fkiwi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/helpscout%2Fkiwi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/helpscout","download_url":"https://codeload.github.com/helpscout/kiwi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244147315,"owners_count":20405942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["ci","cli","github","github-wiki","nodejs","open-source","sync","wiki"],"created_at":"2024-11-25T14:11:31.450Z","updated_at":"2026-04-15T08:34:50.823Z","avatar_url":"https://github.com/helpscout.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🥝 Kiwi\n\n\u003e Seamless syncing for Design Github Wikis\n\nKiwi was specifically designed to handle automatic Wiki deploys for [Help Scout's](https://www.helpscout.com/) Design System.\n\n## Table of Contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Setup](#setup)\n  - [CI Variables](#ci-variables)\n  - [Git User](#git-user)\n- [Usage](#usage)\n- [Examples](#examples)\n  - [Netlify](#netlify)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Setup\n\n### CI Variables\n\nAdd the following global environment variables to your build/CI tool:\n\n```\nGITHUB_USER = bob_belcher_2019\nGITHUB_REPO = baby-you-can-chive-my-car-burger\nTOKEN = CV9$Xc]6iZVJRJiE*uV6MooXg\nLOCAL_DIR = burger-project\n```\n\n##### `GITHUB_USER`\n\nThe Github user name of your repository.\n\n##### `GITHUB_REPO`\n\nThe Github repository name.\n\n##### `TOKEN`\n\nYour super secret [Github personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)\n\n##### `LOCAL_DIR`\n\nThe directory of your (CI) local directory.\n\n### Git User\n\nSince Kiwi needs to push to a Github wiki, ensure that your environment's Git has been set up with a username and email:\n\n```\ngit config --global user.email \"bob@bobsburgers.com\"\ngit config --global user.name \"bob_belcher_2019\"\n```\n\n## Usage\n\nOnce you have the above ☝️ set up (it's very important!), all you have to do is run:\n\n```\nnpx @helpscout/kiwi\n```\n\n## Examples\n\n### Netlify\n\nFor [Netlify](https://www.netlify.com/), you can create a simple `netlify.sh` file (or call it whatever you'd like 😍)\n\n```\n# Configures the Git name and email for the commits\ngit config --global user.email \"bob@bobsburgers.com\"\ngit config --global user.name \"bob_belcher_2019\"\n\n# Set the environment variables\nexport GITHUB_USER=bob_belcher_2019\nexport GITHUB_REPO=baby-you-can-chive-my-car-burger\nexport TOKEN=CV9$Xc]6iZVJRJiE*uV6MooXg\nexport LOCAL_DIR=repo\n\n# Runs Kiwi\nnpx @helpscout/kiwi\n\n# Creates an empty page for Netlify to deploy\nmkdir public\ntouch public/index.html\n```\n\nWith that, you can set up the following:\n\n- **Build command**: `sh netlify.sh`\n- **Publish directory**: `public`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpscout%2Fkiwi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhelpscout%2Fkiwi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhelpscout%2Fkiwi/lists"}