github-to-html

A proof of concept that pulls GitHub repo info and generates a static site using eleventy

Configuration

The core functionality of the site is managed by defining options in a config.json file placed at the root of your repository instance. You can define the following configuration parameters:

Parameter	Description	Default
homepageTitle	name of the site that will appear in the nav bar	GitHub Issues
githubUser	name of GitHub user or organization	lonnygomes
githubRepo	name of repository	vjs-video
pathPrefix	base path where site should live	'/github-to-html'
octokitOptions	options to configure the @octokit/rest instance	{}

Sample config.json

{
    "homepageTitle": "My Site",
    "githubUser": "myorg",
    "githubRepo": "myrepo",
    "pathPrefix": "/github-to-html",
    "octokitOptions": {
        "auth": "ABCTOKEN123"
    }
}