Format
Following json formats is important as it allows us to easily process your domain without any issues. If the correct json format is not followed, you will be told and the pull request will not be merged.
Currently we only accept A and CNAME records. If you would like your domain to be redirected, you will have to use external tools such as redirect.pizza as we don't have the required resources to do this at the moment.
When submitting your pull request, we ask that you add your email under the email key in the json. This is so that we can contact you if anything is due to change or if your sub-domain has violated laws, terms or anything of that nature. Invalid contact details will be refused a sub-domain.

JSON Format Template

{
"repo": "",
"owner": {
"username": "",
"email": ""
},
"target": {
"record-type": {
"name": "",
"value": ""
}
},
"proxied": false
}
Breakdown of the JSON template:
  • "repo" - This is your repository, the place where the code for the site is. If you don't have a repository you can leave this blank.
  • "owner" - This is a category for your information. This section needs to be filled out, or your PR will not be merged.
    • "username" - This is where you put your Github username.
    • "email" - This is where you put your email.
  • "record-type" - This is a category for the record information.
    • "name" - This is the desired subdomain.
    • "value" - This is the value for the record, for example with an A record it would be an IP.
  • "proxied" - Whether you need it proxied through Cloudflare. If you don't know what it means, leave it to false.

JSON Example

{
"repo": "https://github.com/is-a-good-dev/docs",
"owner": {
"username": "is-a-good-dev",
"email": "[email protected]"
},
"target": {
"CNAME": {
"name": "docs",
"value": "hosting.gitbook.io"
}
},
"proxied": false
}
You can find the the file here.
If you are unsure about this, open a new issue and one of the maintainers or contributors will help you out.
Copy link
Edit on GitHub
On this page
JSON Format Template
JSON Example