reg-publish-github-pages-plugin
A reg-suit plugin to fetch and publish assets to the GitHub pages.
Install
npm i -D reg-publish-github-pages-plugin
reg-suit prepare -p publish-github-pages
Setup
You need to configure GitHub pages before using this plugin.
See the official documentation
Configure
{
repository: string;
branchName: string;
token: string;
customDomain?: string;
pathPrefix?: string;
}
-
repository
- Required - A repository name in the form ofowner/name
such asLeko/reg-publish-github-pages-plugin
. -
branchName
- Required - A branch name for the GitHub pages. -
token
- Required - A GitHub token. You can pass the value via Embed environment values -
customDomain
- Optional - A custom domain when you set it to the GitHub pages. -
pathPrefix
- Optional - Specify paths. For example, when you setsome_dir
as this property, this plugin will publish with URL such ashttps://{TODO}/some_dir/index.html
.