After your pull request has been merged with the main repository you should be able to visit your new is-a.dev domain and it should show you your pages.dev site
+if it doesn't then you have configured your domain wrong.
After your pull request has been merged, repeat the steps to get the verification string and press the Verify button.
+If it shows any error such as Unable to verify your domain, try waiting a few minutes (sometimes up to 24 hours) as the DNS change might not have reflected on the DNS server.
To register a subdomain, you need to create a new JSON file in the domains directory through a pull request. For example, to register example.is-a.dev, you would create a file named example.json in the domains directory. The full path would be domains/example.json.
+
Filename
+
Note: You can include . (dots) in your filename to register a sub-subdomain (e.g., blog.example.is-a.dev). However, each segment of your subdomain must meet the following criteria:
+
The filename:
+
+
Must be alphanumeric, in lowercase, with dashes as separators.
+
Must be at least 2 characters.
+
Must have a .json file extension.
+
+
Examples of Invalid Filenames
+
+
a.json (filename is less than 2 characters)
+
A.json (filename contains uppercase letters)
+
a..json (filename contains consecutive dots)
+
.a.json (filename starts with a dot)
+
a .json (filename contains a space)
+
a$.json (filename contains a non-alphanumeric character)
+
a.json.json (filename contains more than one .json extension)
+
+
Examples of Valid Filenames
+
All the filenames below meet all the criteria. The reason in parentheses is just an example of one of the criteria they meet.
+
+
ab.json (at least 2 characters long)
+
example.json (alphanumeric and in lowercase)
+
blog.example.json (includes dots to register a sub-subdomain)
+
my-blog.json (uses dashes as separators, which is recommended)
+
+
Structure
+
owner (required)
+
You need to specify some information about yourself here. This is so that you can be contacted if required.
+In the owner object, the fields username and email are required. You can add more information in this object if you want.
+
Describe your domain name and your usage. This is purely for documentation purpose and is optional.
+
repo
+
This is a link to your website repository or your github account. This is purely for documentation purpose and is optional.
+
record (required)
+
This section is where you specify the DNS records. The supported types are:
+
+
CNAME
+
A
+
AAAA
+
URL
+
MX
+
TXT
+
+
Below are some examples for the given record types:
+
+
CNAME record: This must be a hostname (something.tld). It cannot be used in conjunction with any other record types. This is typically used to map your domain to a specific server.
+
TXT record: This can be either a single string or a list of strings. TXT records are often used for various purposes, such as verifying domain ownership and ensuring email security.
+
You can create a GitHub pages website by creating a repository with the name <github-username>.github.io. For more information about GitHub pages, please read through their guide.
+
Creating the domain file
+
Create a JSON file inside domains directory (domains/<subdomain>.json) with the following content
+
{
+"description":"Describe the use of this subdomain",
+"repo":"https://github.com/<github-username>/<github-username>.github.io",
+"owner":{
+"username":"<github-username>",
+"email":"email@address",
+"twitter":"<twitter-username>"
+},
+"record":{
+"CNAME":"<username>.github.io"
+}
+}
+
+
Configuring
+
+
After the pull request is merged, you will see a 404 error on <your-subdomain>.is-a.dev. To fix this, go to your GitHub pages repository's Settings > GitHub pages > Custom domain and add <your-subdomain>.is-a.dev in the given field. Only do this after your pull request is merged.
+
Check the Enforce HTTPS checkbox below the custom domain input.
+
+
Using is-a.dev for all GitHub Pages sites in your account
+
It is possible to have a unique subdomain on your is-a.dev domain for each repository which has Pages enabled.
+
In order to utilise this, you must ensure the following conditions are met:
+1) The website which hosts the "root" (<subdomain>.is-a.dev) must be named <username>.github.io
+2) That repo must have <subdomain>.is-a.dev as the custom domain within the Pages settings.
+3) Every other repo must not have a custom domain set in the Pages settings.
+4) Links to these hosted repos must end with / (e.g https://<subdomain>.is-a.dev/<project>/)
After your pull request has been merged, repeat the steps to get the verification string and press the Verify button.
+If it shows any error such as Unable to verify your domain, try waiting a few minutes (sometimes up to 24 hours) as the DNS change might not have reflected on the DNS server.
When you create your hashnode blog, hashnode provides a free hashnode.dev subdomain for you. However, you can set up your own is-a.dev subdomain.
+
In this guide, you will learn how to accomplish this.
+
+
+
+
Log in to your Hashnode account.
+
+
+
Click on your avatar at the bottom-left corner of the page on desktop or top-right corner on mobile.
+
+
+
+
+
Click on the Blog Dashboard option from the popup modal to access your blog's dashboard.
+
+
+
+
Navigate to the Domain tab and enter your domain without the www or https:// prefix in the text field provided. Then click on the Update button to proceed.
+
+
+
+
Go to your fork of the is-a-dev/register repository, edit your subdomain's JSON file, make sure you remove any old records, then add this:
+
"CNAME":"hashnode.network"
+
+
+
Once done, your hashnode blog is setup to use your subdomain, all you have to do is wait sometime for the DNS to propogate. These changes could take from 1 hour to around 48 hours, so please be patient, It'll most likely be ready within a hour.
+Enjoy your hashnode Blog, With Your Sweet .is-a.dev Subdomain! If your need more help: please read this support article on hashnode support: https://support.hashnode.com/docs/mapping-domain/, this should help you more, if you need more help related to Hashnode, then please visit the Hashnode Support Center. Remeber, is-a.dev has no links with hashnode, so please do not create issues on our github, saying that your hashnode blog is having issues, we simply will not respond to them.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/img/banner.png b/img/banner.png
new file mode 100644
index 00000000..bfa9b813
Binary files /dev/null and b/img/banner.png differ
diff --git a/img/delete_domain_step_1.png b/img/delete_domain_step_1.png
new file mode 100644
index 00000000..2815a79e
Binary files /dev/null and b/img/delete_domain_step_1.png differ
diff --git a/img/delete_domain_step_2.png b/img/delete_domain_step_2.png
new file mode 100644
index 00000000..d951cd2f
Binary files /dev/null and b/img/delete_domain_step_2.png differ
diff --git a/img/delete_domain_step_3.png b/img/delete_domain_step_3.png
new file mode 100644
index 00000000..d7d84049
Binary files /dev/null and b/img/delete_domain_step_3.png differ
diff --git a/img/delete_domain_step_4.png b/img/delete_domain_step_4.png
new file mode 100644
index 00000000..6140b269
Binary files /dev/null and b/img/delete_domain_step_4.png differ
diff --git a/img/delete_domain_step_5.png b/img/delete_domain_step_5.png
new file mode 100644
index 00000000..b40cf420
Binary files /dev/null and b/img/delete_domain_step_5.png differ
diff --git a/img/discord_step_1.png b/img/discord_step_1.png
new file mode 100644
index 00000000..29e8ca89
Binary files /dev/null and b/img/discord_step_1.png differ
diff --git a/img/discord_step_2.png b/img/discord_step_2.png
new file mode 100644
index 00000000..13b5affd
Binary files /dev/null and b/img/discord_step_2.png differ
diff --git a/img/discord_step_3.png b/img/discord_step_3.png
new file mode 100644
index 00000000..95ff15ec
Binary files /dev/null and b/img/discord_step_3.png differ
diff --git a/img/discord_step_4.png b/img/discord_step_4.png
new file mode 100644
index 00000000..ef1e437f
Binary files /dev/null and b/img/discord_step_4.png differ
diff --git a/img/discord_step_5.png b/img/discord_step_5.png
new file mode 100644
index 00000000..1af09f72
Binary files /dev/null and b/img/discord_step_5.png differ
diff --git a/img/discord_step_6.png b/img/discord_step_6.png
new file mode 100644
index 00000000..227eb120
Binary files /dev/null and b/img/discord_step_6.png differ
diff --git a/img/edit_domain_step_1.png b/img/edit_domain_step_1.png
new file mode 100644
index 00000000..d2258b95
Binary files /dev/null and b/img/edit_domain_step_1.png differ
diff --git a/img/edit_domain_step_2.png b/img/edit_domain_step_2.png
new file mode 100644
index 00000000..4dc8f615
Binary files /dev/null and b/img/edit_domain_step_2.png differ
diff --git a/img/edit_domain_step_3.png b/img/edit_domain_step_3.png
new file mode 100644
index 00000000..e6541ff3
Binary files /dev/null and b/img/edit_domain_step_3.png differ
diff --git a/img/edit_domain_step_4.png b/img/edit_domain_step_4.png
new file mode 100644
index 00000000..32d87b05
Binary files /dev/null and b/img/edit_domain_step_4.png differ
diff --git a/img/edit_domain_step_5.png b/img/edit_domain_step_5.png
new file mode 100644
index 00000000..66f71017
Binary files /dev/null and b/img/edit_domain_step_5.png differ
diff --git a/img/edit_domain_step_6.png b/img/edit_domain_step_6.png
new file mode 100644
index 00000000..26681d05
Binary files /dev/null and b/img/edit_domain_step_6.png differ
diff --git a/img/edit_domain_step_7.png b/img/edit_domain_step_7.png
new file mode 100644
index 00000000..a75a0873
Binary files /dev/null and b/img/edit_domain_step_7.png differ
diff --git a/img/favicon.ico b/img/favicon.ico
new file mode 100644
index 00000000..d4eddfab
Binary files /dev/null and b/img/favicon.ico differ
diff --git a/img/github_pages_verification_step_1.png b/img/github_pages_verification_step_1.png
new file mode 100644
index 00000000..9f7ff980
Binary files /dev/null and b/img/github_pages_verification_step_1.png differ
diff --git a/img/github_pages_verification_step_2.png b/img/github_pages_verification_step_2.png
new file mode 100644
index 00000000..6d28dc8e
Binary files /dev/null and b/img/github_pages_verification_step_2.png differ
diff --git a/img/github_pages_verification_step_3.png b/img/github_pages_verification_step_3.png
new file mode 100644
index 00000000..883495b5
Binary files /dev/null and b/img/github_pages_verification_step_3.png differ
diff --git a/img/github_pages_verification_step_4.png b/img/github_pages_verification_step_4.png
new file mode 100644
index 00000000..16d2100d
Binary files /dev/null and b/img/github_pages_verification_step_4.png differ
diff --git a/img/github_pages_verification_step_5.png b/img/github_pages_verification_step_5.png
new file mode 100644
index 00000000..87bc45e8
Binary files /dev/null and b/img/github_pages_verification_step_5.png differ
diff --git a/index.html b/index.html
new file mode 100644
index 00000000..13576cce
--- /dev/null
+++ b/index.html
@@ -0,0 +1,562 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ is-a.dev Docs
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
You will encounter an SSL certificate issue when using Vercel and Netlify. Neither service will work with our domains. It is recommended to use GitHub Pages, Railway or Cloudflare Pages instead.
After the pull request is merged, configure your server (apache, nginx, etc.) to work with <subdomain>.is-a.dev. If you are unsure how to configure your server, you can create an issue for support.
+
You should also, include <subdomain>.is-a.dev in your ssl certificate to get rid of certificate errors.
Enter the value from clipboard in the Record Value field.
+
Click on the Submit Query button.
+
Wait for your pull request to be merged and the DNS records to update.
+
+
If the PR has been merged, the DNS records will be updated in a few minutes.
+If the PR has been merged but the DNS records haven't updated and you have waited 48 hours, open a GitHub issue or a help thread in the is-a.dev discord server.
After your pull request has been merged with the main repository you should be able to visit your new is-a.dev domain and it should show you your replit site
+if it doesn't then you have configured your domain wrong.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search/search_index.json b/search/search_index.json
new file mode 100644
index 00000000..f357b918
--- /dev/null
+++ b/search/search_index.json
@@ -0,0 +1 @@
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"How to Register","text":"
You can read more about the domains JSON file structure here.
"},{"location":"#vercel-and-netlify","title":"Vercel and Netlify","text":"
You will encounter an SSL certificate issue when using Vercel and Netlify. Neither service will work with our domains. It is recommended to use GitHub Pages, Railway or Cloudflare Pages instead.
"},{"location":"cloudflare_pages/","title":"Setting up Cloudflare pages with your is-a.dev subdomain","text":""},{"location":"cloudflare_pages/#creating-a-pagesdev-site","title":"Creating a pages.dev site","text":"
Follow their guide on how to set it up.
"},{"location":"cloudflare_pages/#point-your-pagesdev-site-to-your-is-adev-subdomain","title":"Point your pages.dev site to your is-a.dev subdomain","text":"
Follow their guide on how to do it. Only follow the \"Add a custom domain\" section and then follow the rest of the steps here.
"},{"location":"cloudflare_pages/#creating-the-domain-file","title":"Creating the domain file","text":"
Create a JSON file inside domains directory (domains/<subdomain>.json) with the following content:
After your pull request has been merged with the main repository you should be able to visit your new is-a.dev domain and it should show you your pages.dev site if it doesn't then you have configured your domain wrong.
"},{"location":"dashboard/","title":"Register your is-a.dev subdomain using the is-a-dev Dashboard","text":""},{"location":"dashboard/#login-to-the-dashboard","title":"Login to the dashboard","text":"
First login to the dashboard using your GitHub account.
"},{"location":"dashboard/#registering-your-subdomain","title":"Registering your subdomain","text":"
On the left hand side, click on the button that says Register with a keyboard icon.
Then follow the steps to register your subdomain.
It will fork the is-a-dev/register repository, assuming you haven't done that already and it will create a pull request for you.
Finally, you'll have to wait for a maintainer to merge it, which should not take too long.
"},{"location":"delete_domain/","title":"How to delete your is-a.dev domain","text":""},{"location":"delete_domain/#open-your-fork-of-the-is-a-devregister-repository","title":"Open your fork of the is-a-dev/register repository","text":"
Open your fork, or if you deleted it, fork the repository once again.
Find your domain file in the domains/ folder (e.g. /domains/myname.json)
Press the 3 dots and press the Delete file button.
Press Commit changes.
In the popup that appears, press Commit changes once again.
Click the Contribute button, then press Open pull request.
Press Create pull request again.
And you're done! After you pull request has been merged, the domain will be deleted.
"},{"location":"discord_verification/","title":"Setting up Discord domain connection with your is-a.dev domain","text":""},{"location":"discord_verification/#get-your-verification-string","title":"Get your verification string","text":"
Open your Discord app and press Settings.
Open the Connections section.
Press the View more button.
Click on the domain button (the globe icon).
In the field that appears type your is-a.dev domain name (e.g. myname.is-a.dev).
Copy the verification string.
"},{"location":"discord_verification/#create-the-domain-file","title":"Create the domain file","text":"
Create a JSON file inside the domains/ directory called domains/_discord.yourname.json with the following content:
After your pull request has been merged, repeat the steps to get the verification string and press the Verify button. If it shows any error such as Unable to verify your domain, try waiting a few minutes (sometimes up to 24 hours) as the DNS change might not have reflected on the DNS server.
To register a subdomain, you need to create a new JSON file in the domains directory through a pull request. For example, to register example.is-a.dev, you would create a file named example.json in the domains directory. The full path would be domains/example.json.
Note: You can include . (dots) in your filename to register a sub-subdomain (e.g., blog.example.is-a.dev). However, each segment of your subdomain must meet the following criteria:
The filename:
Must be alphanumeric, in lowercase, with dashes as separators.
Must be at least 2 characters.
Must have a .json file extension.
"},{"location":"domain_structure/#examples-of-invalid-filenames","title":"Examples of Invalid Filenames","text":"
a.json (filename is less than 2 characters)
A.json (filename contains uppercase letters)
a..json (filename contains consecutive dots)
.a.json (filename starts with a dot)
a .json (filename contains a space)
a$.json (filename contains a non-alphanumeric character)
a.json.json (filename contains more than one .json extension)
"},{"location":"domain_structure/#examples-of-valid-filenames","title":"Examples of Valid Filenames","text":"
All the filenames below meet all the criteria. The reason in parentheses is just an example of one of the criteria they meet.
ab.json (at least 2 characters long)
example.json (alphanumeric and in lowercase)
blog.example.json (includes dots to register a sub-subdomain)
my-blog.json (uses dashes as separators, which is recommended)
You need to specify some information about yourself here. This is so that you can be contacted if required. In the owner object, the fields username and email are required. You can add more information in this object if you want.
This section is where you specify the DNS records. The supported types are:
CNAME
A
AAAA
URL
MX
TXT
Below are some examples for the given record types:
CNAME record: This must be a hostname (something.tld). It cannot be used in conjunction with any other record types. This is typically used to map your domain to a specific server.
TXT record: This can be either a single string or a list of strings. TXT records are often used for various purposes, such as verifying domain ownership and ensuring email security.
"},{"location":"edit_domain/","title":"How to edit your is-a.dev domain","text":""},{"location":"edit_domain/#open-your-fork-of-the-is-a-devregister-repository","title":"Open your fork of the is-a-dev/register repository","text":"
Open your fork, or if you deleted it, fork the repository once again.
Find your domain file in the domains/ folder (e.g. /domains/myname.json)
Press the Edit this file button (a pencil icon).
Apply your changes in the text field and then press the Commit changes button.
In the pop-up that appears, press the button Commit changes.
Press on the register text to go back to the homepage of the repository.
Press the Contribute button and then press on the Open pull request button.
Press the Create pull request button.
Complete the pull request template in the description field, add a title to the pull request, then press Create pull request.
And you're done! After you pull request has been merged, the domain should be updated with-in 24 hours.
"},{"location":"github_pages/","title":"Setting up GitHub pages with is-a.dev subdomain","text":""},{"location":"github_pages/#creating-a-github-pages-repository","title":"Creating a GitHub pages repository","text":"
You can create a GitHub pages website by creating a repository with the name <github-username>.github.io. For more information about GitHub pages, please read through their guide.
"},{"location":"github_pages/#creating-the-domain-file","title":"Creating the domain file","text":"
Create a JSON file inside domains directory (domains/<subdomain>.json) with the following content
{\n\"description\": \"Describe the use of this subdomain\",\n\"repo\": \"https://github.com/<github-username>/<github-username>.github.io\",\n\"owner\": {\n\"username\": \"<github-username>\",\n\"email\": \"email@address\",\n\"twitter\": \"<twitter-username>\"\n},\n\"record\": {\n\"CNAME\": \"<username>.github.io\"\n}\n}
After the pull request is merged, you will see a 404 error on <your-subdomain>.is-a.dev. To fix this, go to your GitHub pages repository's Settings > GitHub pages > Custom domain and add <your-subdomain>.is-a.dev in the given field. Only do this after your pull request is merged.
Check the Enforce HTTPS checkbox below the custom domain input.
"},{"location":"github_pages/#using-is-adev-for-all-github-pages-sites-in-your-account","title":"Using is-a.dev for all GitHub Pages sites in your account","text":"
It is possible to have a unique subdomain on your is-a.dev domain for each repository which has Pages enabled.
In order to utilise this, you must ensure the following conditions are met: 1) The website which hosts the \"root\" (<subdomain>.is-a.dev) must be named <username>.github.io 2) That repo must have <subdomain>.is-a.dev as the custom domain within the Pages settings. 3) Every other repo must not have a custom domain set in the Pages settings. 4) Links to these hosted repos must end with / (e.g https://<subdomain>.is-a.dev/<project>/)
"},{"location":"github_pages_verification/","title":"Verify your is-a.dev Domain with GitHub Pages","text":""},{"location":"github_pages_verification/#get-your-verification-string","title":"Get your verification string","text":"
Open GitHub, press on your profile icon on the top right, and press Settings.
Press Pages.
Press Add a domain.
In the field that appears, type your is-a.dev domain name (e.g., myname.is-a.dev) and press Add domain.
Copy the hostname and the verification string.
"},{"location":"github_pages_verification/#create-the-domain-file","title":"Create the domain file","text":"
Create a JSON file inside the domains/ directory called domains/hostname.json using the hostname you copied in step 5 with the following content:
After your pull request has been merged, repeat the steps to get the verification string and press the Verify button. If it shows any error such as Unable to verify your domain, try waiting a few minutes (sometimes up to 24 hours) as the DNS change might not have reflected on the DNS server.
When you create your hashnode blog, hashnode provides a free hashnode.dev subdomain for you. However, you can set up your own is-a.dev subdomain.
In this guide, you will learn how to accomplish this.
Log in to your Hashnode account.
Click on your avatar at the bottom-left corner of the page on desktop or top-right corner on mobile.
Click on the Blog Dashboard option from the popup modal to access your blog's dashboard.
Navigate to the Domain tab and enter your domain without the www or https:// prefix in the text field provided. Then click on the Update button to proceed.
Go to your fork of the is-a-dev/register repository, edit your subdomain's JSON file, make sure you remove any old records, then add this:
\"CNAME\": \"hashnode.network\"\n
Once done, your hashnode blog is setup to use your subdomain, all you have to do is wait sometime for the DNS to propogate. These changes could take from 1 hour to around 48 hours, so please be patient, It'll most likely be ready within a hour. Enjoy your hashnode Blog, With Your Sweet .is-a.dev Subdomain! If your need more help: please read this support article on hashnode support: https://support.hashnode.com/docs/mapping-domain/, this should help you more, if you need more help related to Hashnode, then please visit the Hashnode Support Center. Remeber, is-a.dev has no links with hashnode, so please do not create issues on our github, saying that your hashnode blog is having issues, we simply will not respond to them.
"},{"location":"other/","title":"Setting up other services with is-a.dev","text":""},{"location":"other/#setting-up-records","title":"Setting up records","text":"
Read the domain file structure and setup the records accordingly.
"},{"location":"other/#configuring-your-server","title":"Configuring your server","text":"
After the pull request is merged, configure your server (apache, nginx, etc.) to work with <subdomain>.is-a.dev. If you are unsure how to configure your server, you can create an issue for support.
You should also, include <subdomain>.is-a.dev in your ssl certificate to get rid of certificate errors.
"},{"location":"railway/","title":"Setting up is-a.dev with Railway","text":""},{"location":"railway/#getting-the-cname-record","title":"Getting the CNAME Record","text":"
Navigate to the dashboard
Navigate to the project.
Navigate to the service.
Switch to the Settings tab.
Click on + Custom Domain button.
Enter the is-a.dev subdomain you want to use.
Copy the Value field.
Go to the register site.
Choose CNAME record type from the dropdown menu.
Choose your desired subdomain.
Enter the value from clipboard in the Record Value field.
Click on the Submit Query button.
Wait for your pull request to be merged and the DNS records to update.
If the PR has been merged, the DNS records will be updated in a few minutes. If the PR has been merged but the DNS records haven't updated and you have waited 48 hours, open a GitHub issue or a help thread in the is-a.dev discord server.
"},{"location":"replit/","title":"Setting up Replit with your is-a.dev subdomain","text":""},{"location":"replit/#creating-a-project","title":"Creating a project","text":"
Follow their guide on how to set it up.
"},{"location":"replit/#point-your-replit-to-your-is-adev-subdomain","title":"Point your Replit to your is-a.dev subdomain","text":"
Follow their guide on how to do it.
Only follow the \"Connecting your domain to your repl\" section and then follow the rest of the steps here.
"},{"location":"replit/#creating-the-domain-file","title":"Creating the domain file","text":"
Create a JSON file inside domains directory (domains/<subdomain>.json) with the following content:
Please do not add any TXT records even if Replit tells you to do so.
After your pull request has been merged with the main repository you should be able to visit your new is-a.dev domain and it should show you your replit site if it doesn't then you have configured your domain wrong.
