Help Documents
Github pages is a good solution for someone with a standard HTML site without any special programming needs.
Step 1: Create Account.
Go to github.com and click the "Sign up" link in the top right corner.
See screen capture below for the information you will need to provide. Make the username relevant to your organization. Notice my username is stephanie-lynn-226. This will be important later.
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/setup.png?version=1&modificationDate=1696538462000&cacheVersion=1&api=v2&width=650&height=383)
Step 2: Choose Account Type
We recommend choosing "teacher" with 2-5 members so that you will be able to collaborate your account with a member of our support staff so we can assist with moving the files from your old site to Github pages.
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/Screen%20Shot%202023-05-09%20at%208.33.37%20AM.png?version=1&modificationDate=1683636013000&cacheVersion=1&api=v2&width=400&height=550)
Step 3: Choose Account Level
We have found that the free account provides everything you need to host a single HTML web site.
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/Screen%20Shot%202023-05-09%20at%208.33.59%20AM%20(2).png?version=2&modificationDate=1683636083000&cacheVersion=1&api=v2&width=700&height=622)
Step 4: Create your repository
Click the Green "Create Repository" button.
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/Screen%20Shot%202023-05-09%20at%208.34.18%20AM.png?version=1&modificationDate=1683636115000&cacheVersion=1&api=v2&width=700&height=384)
Next, create a name for your repository. This step is very important. You will need to name your repo such that it will need to have your username in it.
In this example, my username is stephanie-lynn-226. I named my repo "stephanie-lynn-226.github.io." If you do not name your repo with username.github.io, the files will not be viewable via web browser.
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/newinage.png?version=1&modificationDate=1696538206000&cacheVersion=1&api=v2&width=650&height=273)
Step 5: Add all of your web files to the repository
Here is documentation provided by github. We are not able to provide technical support for this part of the process
https://docs.github.com/en/repositories/working-with-files/managing-files/adding-a-file-to-a-repository
Step 6 (optional): Setting up custom domain
- Create necessary DNS entry as a CNAME and point it to:
<user>.github.io
- DNS must fully propagate before GitHub will allow the domain to be added
- In the Git Repo, navigate to Settings → Code and Automation: Pages → Custom Domain
- Enter the domain and save
After the txt record and cname DNS changes are complete there is one more step
Go to your repo and click "settings", and then choose "pages"
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/Screenshot%202024-09-06%20at%201.40.07%E2%80%AFPM.png?version=1&modificationDate=1725644425645&cacheVersion=1&api=v2&width=300&height=38)
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/Screenshot%202024-09-06%20at%201.40.53%E2%80%AFPM.png?version=1&modificationDate=1725644460868&cacheVersion=1&api=v2&width=100&height=211)
Enter your custom domain here and save. It will take about 30 minutes to fully provision
![](https://franklinoit.atlassian.net/wiki/download/thumbnails/25275769/Screenshot%202024-09-06%20at%201.41.27%E2%80%AFPM.png?version=1&modificationDate=1725644532405&cacheVersion=1&api=v2&width=300&height=65)