@helpscout/kiwi
Seamless syncing for Design Wikis
Last updated a year ago by helpscout .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @helpscout/kiwi 
SYNC missed versions from official npm registry.

???? Kiwi

Seamless syncing for Design Github Wikis

Kiwi was specifically designed to handle automatic Wiki deploys for Help Scout's Design System.

Table of Contents

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

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 "bob@bobsburgers.com"
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, 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 "bob@bobsburgers.com"
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

Current Tags

  • 0.0.17                                ...           latest (a year ago)

17 Versions

  • 0.0.17                                ...           a year ago
  • 0.0.16                                ...           a year ago
  • 0.0.15                                ...           a year ago
  • 0.0.14                                ...           a year ago
  • 0.0.13                                ...           a year ago
  • 0.0.12                                ...           a year ago
  • 0.0.11                                ...           a year ago
  • 0.0.10                                ...           a year ago
  • 0.0.9                                ...           a year ago
  • 0.0.8                                ...           a year ago
  • 0.0.7                                ...           a year ago
  • 0.0.6                                ...           a year ago
  • 0.0.5                                ...           a year ago
  • 0.0.4                                ...           a year ago
  • 0.0.3                                ...           a year ago
  • 0.0.2                                ...           a year ago
  • 0.0.1                                ...           a year ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 17
Last Month 17
Dependencies (2)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |