GitHub content store adaptor for Indiekit.
npm i @indiekit/store-github
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"
}
}
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 . |