@indiekit/store-github

1.0.0-beta.8 • Public • Published

@indiekit/store-github

GitHub content store adaptor for Indiekit.

Installation

npm i @indiekit/store-github

Usage

Add @indiekit/store-github to your list of plug-ins, specifying options as required:

{
  "plugins": ["@indiekit/store-github"],
  "@indiekit/store-github": {
    "user": "username",
    "repo": "reponame"
  }
}

Options

Option Type Description
baseUrl string Enterprise GitHub API URL. Optional, defaults to https://api.github.com.
user string Your GitHub username. Required.
repo string The name of your GitHub repository. Required.
branch string The branch files will be saved to. Optional, defaults to main.
token string A GitHub personal access token. Required, defaults to process.env.GITHUB_TOKEN.

Package Sidebar

Install

npm i @indiekit/store-github

Weekly Downloads

14

Version

1.0.0-beta.8

License

MIT

Unpacked Size

9.01 kB

Total Files

5

Last publish

Collaborators

  • paulrobertlloyd