← Back

enablePages

Enable GitHub Pages on the learner's repository

Examples

Enable GitHub Pages on the default branch:

type: enablePages

Enable GitHub Pages on the gh-pages branch:

type: enablePages
branch: gh-pages

Enable GitHub Pages on the /docs folder of the main branch:

type: enablePages
branch: main
path: /docs

Options

Title Property Description Default Required
Branch branch The name of the branch to enable pages on. This will be the repo's default branch if none was provided.
Path path The name of the folder that contains the pages site. This defaults to /. /