Skip to content

Subdomain Determination

Stefan Keim edited this page Jun 12, 2019 · 8 revisions

to make a pull request you have to determine a valid subdomain for your GitHub Page in advance.

User-/Organisation Page

if your GitHub URL looks like "foo.github.io" you should request the subdomain "foo"

Project Page

for a GitHub URL like "foo.github.io/bar", the subdomains "foo" or "bar" are possible

Exceptions

The requested subdomain should match your username or the name of your project as close as possible; but exceptions are possible for the sake of clarity, e.g.:

  • "foojs" > "foo"
  • "foo42" > "foo"
  • "Foo" > "foo"
  • "foo-lib" > "foo"

Organization repository mapping

If a subdomain maps to a github or gitlab organization,

'organization': 'organization.git[hub|lab].io',

all repositories of this organization that have published git pages will also be mapped to js.org.

If the git page of a repository is reachable at https://organization.git[hub|lab].io/repository before switching, https://organization.js.org/repository will be reachable after the switch.

As long as the organization page has a CNAME file, the repositories do not need separate CNAME settings for this to work.

Clone this wiki locally