GitHubRepo

class GitHubRepo(ownerType: OwnerType, ownerName: String, repoName: String, scheme: String = "https://", domainName: String = GITHUB) : AbstractRepo

A ContentRoot representing a GitHub repository.

Raw content is fetched via raw.githubusercontent.com.

ownerType

whether the owner is a user or organization

ownerName

the GitHub username or organization name

repoName

the repository name

scheme

the URL scheme, defaults to "https://"

domainName

the GitHub domain, defaults to "github.com"

Constructors

constructor(ownerType: OwnerType, ownerName: String, repoName: String, scheme: String = "https://", domainName: String = GITHUB)

The URL prefix used to access raw file content from this repository.

open override val remote: Boolean = true

Whether this root points to a remote location.

open override val sourcePrefix: String

The prefix path or URL used to resolve files within this root.

open override fun file(path: String): UrlSource

Creates a ContentSource for the given relative path within this root.

open override fun toString(): String