Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helpscout/kiwi
🥝 Kiwi: Seamless syncing for Design Wikis
https://github.com/helpscout/kiwi
ci cli github github-wiki nodejs open-source sync wiki
Last synced: about 2 months ago
JSON representation
🥝 Kiwi: Seamless syncing for Design Wikis
- Host: GitHub
- URL: https://github.com/helpscout/kiwi
- Owner: helpscout
- License: mit
- Created: 2019-02-07T00:46:06.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T12:37:00.000Z (about 2 years ago)
- Last Synced: 2024-11-19T14:35:35.314Z (about 2 months ago)
- Topics: ci, cli, github, github-wiki, nodejs, open-source, sync, wiki
- Language: JavaScript
- Homepage: https://style.helpscout.com
- Size: 1.37 MB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🥝 Kiwi
> Seamless syncing for Design Github Wikis
Kiwi was specifically designed to handle automatic Wiki deploys for [Help Scout's](https://www.helpscout.com/) Design System.
## Table of Contents
- [Setup](#setup)
- [CI Variables](#ci-variables)
- [Git User](#git-user)
- [Usage](#usage)
- [Examples](#examples)
- [Netlify](#netlify)
## Setup
### CI Variables
Add the following global environment variables to your build/CI tool:
```
GITHUB_USER = bob_belcher_2019
GITHUB_REPO = baby-you-can-chive-my-car-burger
TOKEN = CV9$Xc]6iZVJRJiE*uV6MooXg
LOCAL_DIR = burger-project
```
##### `GITHUB_USER`
The Github user name of your repository.
##### `GITHUB_REPO`
The Github repository name.
##### `TOKEN`
Your super secret [Github personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
##### `LOCAL_DIR`
The directory of your (CI) local directory.
### Git User
Since Kiwi needs to push to a Github wiki, ensure that your environment's Git has been set up with a username and email:
```
git config --global user.email "[email protected]"
git config --global user.name "bob_belcher_2019"
```
## Usage
Once you have the above ☝️ set up (it's very important!), all you have to do is run:
```
npx @helpscout/kiwi
```
## Examples
### Netlify
For [Netlify](https://www.netlify.com/), you can create a simple `netlify.sh` file (or call it whatever you'd like 😍)
```
# Configures the Git name and email for the commits
git config --global user.email "[email protected]"
git config --global user.name "bob_belcher_2019"
# Set the environment variables
export GITHUB_USER=bob_belcher_2019
export GITHUB_REPO=baby-you-can-chive-my-car-burger
export TOKEN=CV9$Xc]6iZVJRJiE*uV6MooXg
export LOCAL_DIR=repo
# Runs Kiwi
npx @helpscout/kiwi
# Creates an empty page for Netlify to deploy
mkdir public
touch public/index.html
```
With that, you can set up the following:
- **Build command**: `sh netlify.sh`
- **Publish directory**: `public`