diff --git a/.gitbook/assets/16BF6A7B-509B-402D-A299-E8AF9A78E555_4_5005_c.jpeg b/.gitbook/assets/16BF6A7B-509B-402D-A299-E8AF9A78E555_4_5005_c.jpeg new file mode 100644 index 0000000..a610153 Binary files /dev/null and b/.gitbook/assets/16BF6A7B-509B-402D-A299-E8AF9A78E555_4_5005_c.jpeg differ diff --git a/.gitbook/assets/5E11EFD0-4C27-429D-83B9-6EA75D3BD429.jpeg b/.gitbook/assets/5E11EFD0-4C27-429D-83B9-6EA75D3BD429.jpeg new file mode 100644 index 0000000..a5f5e12 Binary files /dev/null and b/.gitbook/assets/5E11EFD0-4C27-429D-83B9-6EA75D3BD429.jpeg differ diff --git a/.gitbook/assets/69B1831A-3415-4DBB-93E6-F9A6281DB0EA.jpeg b/.gitbook/assets/69B1831A-3415-4DBB-93E6-F9A6281DB0EA.jpeg new file mode 100644 index 0000000..e43d7bb Binary files /dev/null and b/.gitbook/assets/69B1831A-3415-4DBB-93E6-F9A6281DB0EA.jpeg differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..71c45fa --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +--- +cover: >- + https://images.unsplash.com/photo-1726441344398-1c8b0953df71?crop=entropy&cs=srgb&fm=jpg&ixid=M3wxOTcwMjR8MHwxfHJhbmRvbXx8fHx8fHx8fDE3Mjg3NjQ5ODR8&ixlib=rb-4.0.3&q=85 +coverY: 0 +layout: + cover: + visible: true + size: full + title: + visible: true + description: + visible: false + tableOfContents: + visible: true + outline: + visible: true + pagination: + visible: true +--- + +# 👋 welcome + +welcome to the is-not.cool subdomain service documentation, here you learn exactly how to set up your subdomain from us + +
getting a subdomainhow to get a subdomain from usquickstart.md
supported hostswebsite hosts that we supportBroken link
verificationhow to get the subdomain verified under the providerpublish-your-docs.md
diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..65ace03 --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,12 @@ +# Table of contents + +* [👋 welcome](README.md) + +## getting a subdomain + +* [🏃‍♂️ quickstart](getting-a-subdomain/quickstart.md) +* [🤝 making a pull request](getting-a-subdomain/publish-your-docs.md) + +## Basics + +* [Github Pages](basics/editor.md) diff --git a/basics/editor.md b/basics/editor.md new file mode 100644 index 0000000..635e407 --- /dev/null +++ b/basics/editor.md @@ -0,0 +1,12 @@ +--- +icon: github +--- + +# Github Pages + +using github pages as your provider is really easy, just first follow the steps on "quickstart", after your pull request gets accepted, go to your repository settings, click "Pages", then "Deploy from a branch" then scroll down until "Custom Domain", if my subdomain was "brainrot", i would put in brainrot.is-not.cool. + +
+ +### + diff --git a/getting-a-subdomain/publish-your-docs.md b/getting-a-subdomain/publish-your-docs.md new file mode 100644 index 0000000..f6d1cd6 --- /dev/null +++ b/getting-a-subdomain/publish-your-docs.md @@ -0,0 +1,5 @@ +# 🤝 making a pull request + +making a pull request is really simple! + +go to the "Pull Requests" tab on the repository, click "New pull request", after that click "Create pull request", after that wait for a maintainer to read the pull request. diff --git a/getting-a-subdomain/quickstart.md b/getting-a-subdomain/quickstart.md new file mode 100644 index 0000000..bd6911d --- /dev/null +++ b/getting-a-subdomain/quickstart.md @@ -0,0 +1,37 @@ +# 🏃‍♂️ quickstart + +
+ +first, fork the repository as shown in the photo above this text. + +{% hint style="info" %} +want to learn how to make your own? buy ur own domain +{% endhint %} + +### setting up + +to set up, you will need to make a json file in the "domains" folder, you will need to make sure it follows this format in json and goes like "yoursubdomain".is-not.cool.json + +``` +{ + "description": "insert ur description", + + "domain": "is-not.cool", + "subdomain": "yoursubdomain", + + "owner": { + "repo": "https://github.com/is-not-cool/registration", + "email": "ur email adress" + }, + + "record": { + // choose any dns record that exists and we can try to make it happen + }, + + "proxied": false +} +``` + + + +###