Git and Github Pages Using JAWS
JAWS documentation by Kestrel Verlager and page by Keita Ohshiro. Please email claire(dot)kv(at)nyu(dot)edu, if you have any feedback on this document!
- Git: Works via command line/terminal, and is an example of a Distributed Version Control System (DVCS), provides a method to create a shareable working copy of code and also contains the full history of changes to that code.
- Github: provides hosting for software development and version control through a website interface (not the friendliest site to navigate)
- Github Pages: GitHub Pages is a static web hosting service offered by GitHub and these pages must be initialized through the Github interface. After that however, it is easiest to add to and change them via the command line.
- Command line: The command line is a text interface for your computer. It's a program that takes in commands, which it passes on to the computer's operating system to run.
Git Set up
- Check if you have Git Installed through the Command Line
If you do not have git (per the last few steps), Install Git (on a Windows machine)
- Press the Windows key.
- Type "command prompt" (without the quotes) in the search box. Usually, Windows will auto-complete "command prompt app" before you have typed very many letters.
- Press enter.
- The cursor is now sitting on the command line. If you press Jaws key+t, you will hear "Command prompt."
- On the Command Line, type "git --version". If Git is installed, the command line will produce a message showing your Git version like "git version 2.24.1". Otherwise, Git is not installed.
- To close the command prompt app and its window, type "exit" (without the quotes).
- Go to gitforwindows.org and download the Git for Windows installer.
- Once the installer has started, follow the instructions as provided in the Git Setup wizard screen until the installation is complete.
- To verify Git was installed, follow steps 1-6 above
Github Website Steps
Go to github.com. Once the webpage is loaded, the first three items at the top of the page, as read by Jaws, are:
The page title: "The world’s leading software development platform · GitHub"
Skip to content [link]
There are at least four quick ways to navigate to the sign up button:
- Use the "Skip to content" link (note: this doesn't always seem to work).
- Use the Jaws key+F7 links list and then press the s key until you hear "Sign up" (it should be announced after the second press of the "s" key, right after "Sign in").
- Press the quick nav key "e" to go directly to the first edit field in the sign up form, which asks for your username (If you don't know what Quick Nav keys are, go here: freedomscientific.com/SurfsUp/Quick_Keys.htm)
- Use the Windows Control+f keyboard shortcut and search for "sign". This will bring you to two links: Sign in and Sign up.
If you click this Sign Up button, you will be popped right into the first edit field of a sign up form on a different page which is titled "Join GitHub." However, there is also a sign up form in the main region of this page. You can get to it by pressing either of two different quick nav keys, "q" to go to the main region of the page, or "h" to go to the first heading on the page. If you use the q key, you will hear Jaws say "Main region." If you use the h key, you will hear "Built for Developers (heading 1)." Whichever you choose, this will be the same line on the page. Using these quick nav keys are the fastest and easiest way to navigate the GitHub website.
Note about usernames: Think carefully about what you want as your username, as this will be one of the common ways that you are identified by others on GitHub, and it will also be used as part of the address for the URL which is associated with your GitHub account.
Complete the sign up form. This includes having to solve an audio captcha, but you can press the Control key to have the audio clip repeat.
If everything works, you will find a message that you need to verify your account from an email that has been sent to you. If you don't seem to have moved off the page with the form, check that there were no issues with using a username that has already been taken, or an email address that is already associated with another account. For more detailed information about your GitHub account, refer to Setting up and managing your GitHub account.
As soon as you have created your GitHub account, you will be asked if you want to take the GitHub "Hello World" tutorial, skip this step.
Creating a Github Page
- Use profile page as home page for orientation (eg. https://github.com/username)
- In the main region, locate the "Create new" button. You can get to Create new button by either skipping to Main, then Q to main, and then arrow up twice to get to create new, or with quick nav turned on, "B" and "create new" is the first button on screen.
- Select the button to expand the button menu and then select "new repository"
- You are now on a page with the title "Create a New Repository."
- Use the "Skip to content" link or press the quick nav q key to go to the main region of the page.
- You can also press the quick nav h key to go to the heading of the page, which says "Heading 1 Create a new repository."
- Next comes a list which is where you will fill out the information for your new repository (note: this means that, next time you visit this page, you can press the quick nav l key to jump right to this list). The first item in this list is a drop-down menu which allows you to designate the owner. By default, your account is filled in. You will hear: Owner: @Your username [button collapsed menu]. The next line only contains a slash symbol, and the line after that requests a name for the repository, followed by an edit field.
- By typing into this edit field, name your repo username.github.io, where username is your username (or organization name) on GitHub. If the first part of the repository doesn't exactly match your username, it won't work, so make sure to get it right.
- You can skip the rest of the items and select "create repository".
- Now switch over to the Command line interface.
- Go to the folder where you want to store your project. For example, when you want to store your project on your Desktop, type the following into the command line. (Note: You can confirm which directory you are in because the command prompt is the name of your current directory.)
- Clone the new repository you just created. Replacing the words username with your real username, type the following commands on the command line:
After completing this step, Jaws says: Warning: you seem to have cloned an empty repository--ignore this message.
git clone https://github.com/username/username.github.io
- Enter the project folder and add an index.html file:
echo "Hello World" > index.html
- Add, commit, and push your changes:
- git add --all
- git commit -m "Initial commit"
- Note: If this commit step works, you will hear Jaws say something like [master (root-commit)] initial commit, 1 file changed
- git push -u origin master
- Below is an example of a confirmation that your git push has completed successfully. Note: This process may differ depending on the environment, etc, but after making an initial commit, the following status message presents percentages (100%) and "done" messages.
username@10-18-234-241 test % git push origin master
Enumerating objects: 5, done.
Counting objects: 100% (5/5), done.
Writing objects: 100% (3/3), 246 bytes | 246.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
3ffdd46..5af3c80 master -> master
- To close the command prompt app and its window, type "exit" (without the quotes).
- GitHub Pages which is what webpages are called on GitHub.
- Warning: GitHub Pages sites are publicly available on the internet, even if their repositories are private or internal. If you have sensitive data in your site's repository, you may want to remove it before publishing. For more information, see About repository visibility
- Creating a GitHub Pages Site
- Working with GitHub Pages
- GitHub Pages on GitHub Learning Lab: A free short seven-step online course for learning how to create and configure your own webpage
- Learn Version Control with Git: A free ebook for learning Git on the Tower website
- Setting up and managing your GitHub account
- GitHub Glossary: GitHub has created some of its unique terminology, so this glossary that defines those terms is very useful.
- Introduction to GitHub: Learning Lab course I took a different one of these Learning Lab courses and found it to be very manageable: you begin it online but the bot sends individual lessons to you through email.
- Searching for information on GitHub
- Git Handbook
- Creating, Cloning, and Archiving Repositories (This help doc provides much more detail than the Quick Start or Hello World tutorial)
- Creating a New Repository
- About readme files
- Writing and formatting on GitHub
- Getting Started with GitHub Pages
- Table of Contents
- Mastering Markdown Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.