https://github.com/lonnygomes/github-to-html

A proof of concept that pulls GitHub repo info and generates a static site using eleventy
https://github.com/lonnygomes/github-to-html

eleventy github-api ssg static-site-generation static-site-generator

Last synced: 2 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/lonnygomes/github-to-html
• Owner: LonnyGomes
• License: mit
• Created: 2020-02-29T16:51:15.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T22:42:55.000Z (over 3 years ago)
• Last Synced: 2025-10-29T07:39:30.488Z (7 months ago)
• Topics: eleventy, github-api, ssg, static-site-generation, static-site-generator
• Language: JavaScript
• Homepage: https://github-to-html.netlify.com
• Size: 222 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# github-to-html

[![Netlify Status](https://api.netlify.com/api/v1/badges/d37a9e54-24e9-48d8-89b8-792bca949db1/deploy-status)](https://app.netlify.com/sites/github-to-html/deploys)

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

```json

{

    "homepageTitle": "My Site",

    "githubUser": "myorg",

    "githubRepo": "myrepo",

    "pathPrefix": "/github-to-html",

    "octokitOptions": {

        "auth": "ABCTOKEN123"

    }

}

```