mirror of
https://github.com/tiennm99/is-a-dev.git
synced 2026-07-27 10:19:54 +00:00
Update API.md
This commit is contained in:
@@ -2,27 +2,28 @@
|
||||
|
||||
## How to register
|
||||
* First you need to create a pull request with your `domains/my-domain.json` file
|
||||
* This PR will be reviewed, merged
|
||||
* The changes will take effect in less than a day after the PR gets merged
|
||||
* `Github pages` users, need to go to their repo settings page and change the domain to `your-domain.is-a.dev` after everything is done
|
||||
* This PR will be reviewed
|
||||
* The changes will take effect soon after the PR gets merged
|
||||
* And that's it
|
||||
|
||||
Example (for github pages) -
|
||||
### For github pages users
|
||||
* A github pages json file (with cname record and https redirection) will look something like this -
|
||||
```json
|
||||
{
|
||||
"description": "Add some description",
|
||||
"repo": "https://github.com/user/user.github.io",
|
||||
"repo": "https://github.com/github-username/github-username.github.io",
|
||||
"owner": {
|
||||
"username": "your-github-username",
|
||||
"username": "github-username",
|
||||
"email": "any@email"
|
||||
},
|
||||
"record": {
|
||||
"CNAME": "user.github.io"
|
||||
"CNAME": "github-username.github.io",
|
||||
"URL": "https://your-domain.is-a.dev"
|
||||
}
|
||||
}
|
||||
```
|
||||
* After the pull request is merged, you will see a 404 error on `your-domain.is-a.dev`. To fix this go to your github page repo's `Settings > Github pages > Custom domain` and add `your-domain.is-a.dev` in the given field
|
||||
|
||||
NOTE: For github pages users, to fix the 404 you get after registering the domain, add `your-domain.is-a.dev` to your github pages repo in Settings > Github pages > Custom domain.
|
||||
|
||||
|
||||
## Domains json file
|
||||
|
||||
Reference in New Issue
Block a user