GitHubPages

module GitHubPages


Assembly	`Nacara.Plugin.Deploy.GitHubPages`
Attributes	`[<RequireQualifiedAccess>]`

Publishes a build to the branch GitHub Pages serves.

A version is a build of its own, deployed into a directory of its own, so publishing one must leave the others as they were. This writes the new tree from the published one rather than checking it out: the current version becomes the root and the other versions' directories are carried across, or a version's directory is replaced and nothing else is touched.

Which versions exist comes from the versions.json the build wrote.

Functions and values

branch (value: string) (options: GitHubPagesOptions) : GitHubPagesOptions

The branch GitHub Pages serves. Defaults to gh-pages.

Parameter
`value`	The value to use.
`options`	The options so far.

create () : IPlugin

createWith (configure: GitHubPagesOptions -> GitHubPagesOptions) : IPlugin

Ready to register, configured.

Parameter
`configure`	Given the defaults, the options to use.

defaults: GitHubPagesOptions

register (site: Site) : Site

Add publishing to GitHub Pages to a site.

Parameter
`site`	The site to add it to.

registerWith (configure: GitHubPagesOptions -> GitHubPagesOptions) (site: Site) : Site

Add publishing to GitHub Pages to a site, configured.

Parameter
`configure`	Given the defaults, the options to use.
`site`	The site to add it to.

remote (value: string) (options: GitHubPagesOptions) : GitHubPagesOptions

The remote it is pushed to. Defaults to origin.

Parameter
`value`	The value to use.
`options`	The options so far.