Publishing OER with Git Pages
Git Pages requires some setup, but it's worth the hassle because it's good and free web hosting! The following directions will help you to export a
docs folder from HAX, push your changes from the GitHub desktop app to the repo, enable Git Pages, tell it to read from the
/docs folder, add a
.nojekyll file to the directory. Let's do this, step by step.
Exporting from HAX
- Once you are finished editing, click on the back arrow, to take you to "Recent Projects".
- Under the right "more" menu (3 dots), click on "Generate build" to export the content into a folder, called
- The docs folder will look like this:
- Open GitHub Desktop App, and commit the changes.
- Now push the changes to GitHub
- Your GitHub repo should look like this:
Enabling Git Pages
- To enable Github to serve pages in your repo to the Web, you will need to enable some settings. Go to the "Settings" page:
- Scroll down to the "GitHub Pages" section. Under "Source," Choose "Master Branch /docs folder" from the dropdown and hit "Save". This setting means that any folder called
docswill be accessible via a url:
- You will now see a url where you can access your webpage. Copy this URL:
- Now, let's add the URL to the front page of the repo, so others can find it. Go to the front page of the repo and click "Edit" on the far right:
- In the website section, paste in your copied URL from the settings page:
Configuring Git Pages
- There is one extra step to get Git Pages working properly. We have to add an empty file called
.nojekyllto the repository. Click on "Create new file":
.nojekyllinto the name file field.
- Scroll down and click on Commit new file:
- You now have your directory set up properly. See this example:
- Congrats! It can take a few minutes for the website to resolve. Visit the Git Pages URL to see if everything worked properly.