Appendix Episode 42 8-10 min

Accessing Workshop Materials

Downloading the repository, reading offline, keeping updated, audio format.

Listen

Transcript

Alex: Welcome back. Today we're making the workshop materials easier to reach, easier to save, and easier to come back to when you need them.

Jamie: I like this topic because it sounds simple until you're actually trying to find the right file five minutes before an exercise starts.

Alex: Exactly. The same content can show up as Markdown source files, HTML pages, a live website, a local folder on your computer, and even this podcast series. Each format has a different job in your workflow.

Jamie: So there isn't one perfect way to read the workshop. There are a few good doors into the same material.

Alex: Yes. The main course repository is Community-Access/git-going-with-github, and this appendix supports the pre-workshop setup chapter. If a facilitator gives you a workshop link or a Learning Room link, use that shared link first, then use the repository when you want to browse, download, or update the full set of materials.

Jamie: If I'm online and just want to read, where should I start?

Alex: Start with the HTML site at community-access.org when your facilitator points you there. In some workshop setups, the site may also be shared as a GitHub Pages URL that looks like organization dot github dot io slash Learning-Room. The landing page is usually index.html, and it acts like the workshop homepage.

Jamie: What makes that better than opening random files on GitHub?

Alex: The HTML version is built for reading. Internal links between chapters and appendices work like a website, and the pages include headings, skip-to-content links, breadcrumb navigation, and ARIA landmarks. With NVDA or JAWS, you can use H to move by heading, and you can use D in NVDA or R in JAWS to jump to the main landmark on a page.

Jamie: And for low vision learners, the browser is often the familiar place to control zoom, contrast, and spacing.

Alex: Right. The HTML pages are a good workshop default because they need almost no setup. Bookmark the URL so you can get back quickly, especially during live instruction when the group is moving from one chapter to another.

Alex: You can also read the files directly on GitHub.com without downloading anything.

Jamie: This is the part where I always wonder, am I supposed to click the README, the docs folder, or some tiny file name?

Alex: On the repository page, the README renders automatically and works like a front page. To read chapters and appendices, open the docs folder, then choose a file ending in .md. GitHub renders Markdown as formatted text, so you get headings, links, and code blocks instead of only raw punctuation.

Jamie: GitHub's file list can feel crowded with a screen reader. What are the useful shortcuts?

Alex: On the main repository page, press T to open the file finder, then type part of a file name to jump straight to it. In the file listing, treat it like a table or grid and move through rows with your screen reader's table navigation or arrow keys. Once you're inside a file, use H to move by heading, and use the breadcrumb links near the top to move back up through the path, such as repository, docs, then the file name.

Jamie: And the Raw button is for when you want the actual file content, not GitHub's pretty view?

Alex: Yes. The rendered view is better for reading. Raw is useful when you want to save the exact file, because the browser shows the plain source and you can save it from there.

Jamie: What if I want everything on my computer before the workshop, not just one page at a time?

Alex: If you have Git installed, cloning is the recommended route because it gives you a full copy that can be updated later. The command is git clone https://github.com/community-access/git-going-with-github.git. Then move into the folder that was created by the clone, usually with cd git-going-with-github; if your facilitator gave you a different repository such as a Learning Room, use that folder name instead.

Jamie: So cloning brings down more than just the chapters.

Alex: It brings the Markdown source, the HTML output, scripts, learning-room materials, templates, and project files. After cloning, you can open the folder in VS Code with code dot, then use the Explorer panel with Ctrl+Shift+E to browse the file tree. Arrow to a file and press Enter to open it.

Jamie: And if someone does not have Git installed or just does not want the command line?

Alex: Use Download ZIP from GitHub.com. Go to the repository page, find the green Code button near the top of the file listing, open the dropdown, choose Download ZIP, save the file, and extract it to a folder on your computer.

Jamie: That Code button can be a little slippery with a screen reader.

Alex: It is usually after the branch selector and near the repository description. In NVDA or JAWS browse mode, press B to move by buttons until you hear Code, then activate it with Enter or Space. Arrow through the menu until you find Download ZIP. Just remember that a ZIP is a snapshot; it will not update itself later.

Alex: Sometimes you only need one file, like one appendix, one chapter, or a screen reader cheat sheet.

Jamie: Please tell me I don't have to download the whole repository for that.

Alex: You don't. On GitHub.com, navigate to the file you want, then use the Raw button above the file content. When the raw file opens in the browser, press Ctrl+S on Windows or Linux, or Cmd+S on macOS, and save it where you want it.

Jamie: Does that work for the HTML files too?

Alex: Yes. Go into the html folder, open the .html file you want, choose Raw, and save it the same way. If you already cloned the repository, the file is already on your machine, so you can just copy it from the local folder.

Jamie: Before we go farther, what am I actually looking at inside the repository?

Alex: The docs folder has the Markdown source for the chapters and appendices. The html folder has pre-built web page versions, including html/docs for the chapter and appendix pages. The learning-room folder holds practice repository files such as challenges, group exercises, and setup guides, with matching HTML versions under html/learning-room.

Jamie: And the other folders are more project infrastructure?

Alex: Right. The .github folder contains issue templates, a pull request template, Copilot agents, and slash commands. The scripts folder contains the build script that converts Markdown to HTML. At the root of the repository, you will find the README, agendas, facilitator guide, contributing guide, and other project files.

Jamie: Let's say I downloaded the materials before traveling. Can I read everything without internet?

Alex: Yes. Markdown files open in any text editor because they are plain text with lightweight formatting. In VS Code, open a .md file and press Ctrl+Shift+V to open the Markdown preview, which renders headings, links, and code blocks in a more readable view.

Jamie: That preview is helpful for low vision users too, especially if VS Code is already set up with a preferred theme.

Alex: Exactly. VS Code's preview follows your editor environment, including high-contrast themes. For the most polished offline reading, open html/index.html in your browser and navigate from there; the local HTML pages support browser zoom and still link to each other.

Jamie: Do the accessibility features survive when the HTML files are local?

Alex: They do. The landmarks, heading structure, and skip links are embedded in the files, so the offline version behaves much like the online version. The links at the bottom of pages also help you move to nearby chapters and appendices without hunting through folders.

Jamie: So the simple recommendation is browser for reading, VS Code when I want to inspect or edit.

Alex: That's a solid split. Open html/index.html when you want a local homepage. Open the repository folder in VS Code when you want to browse files, read Markdown, or prepare an edit.

Alex: Materials change, so it helps to know how your copy gets updated.

Jamie: This is where cloning and ZIP downloads really behave differently.

Alex: They do. If you cloned with Git, open a terminal in your local copy, move into the repository folder, and run git pull. If you have not changed local files, Git usually updates cleanly. If you have local edits, Git may try to merge them, and the merge conflicts chapter is the place to go if files collide.

Jamie: And what about the HTML after pulling changes?

Alex: If you're maintaining a local HTML copy from the source, run npm run build:html after pulling so the generated pages match the latest Markdown. If you downloaded a ZIP, there is no one-command update. Download a fresh ZIP from the repository and replace your old folder.

Jamie: When would you choose each format?

Alex: For live workshop reading, use the online HTML site because it is current, accessible, and does not require setup. For a quick lookup, GitHub.com is convenient. For offline reference, use the local HTML folder. For contributing improvements, edit the Markdown files in docs. For archiving a copy, use a ZIP or a clone. For staying updated over time, clone is the best choice because git pull is repeatable.

Jamie: And this audio series is another format too, right?

Alex: Yes. The podcast is useful before reading if you want a preview, and after reading if you want reinforcement. It is also a good alternative when visual reading is tiring or when you want to review concepts away from the screen.

Jamie: What about printing or exporting? Some people still like a reference packet.

Alex: For printing, the HTML version is usually easiest: open the page in a browser and use print or save as PDF. For Markdown, use the VS Code preview and print from there, or copy the content into a tool that formats it the way you need. If accessibility matters for the exported file, check the result with your screen reader or magnification setup before depending on it.

Jamie: And if something looks different later because GitHub changed its interface?

Alex: Use the course repository and the facilitator's shared site as the source of truth for workshop content. For GitHub platform behavior, check GitHub's official documentation and changelog because buttons, menus, and shortcuts can change over time.

Jamie: So the big choice is not mysterious: online HTML for the live workshop, local HTML for offline reading, Markdown for editing, Git clone for updates, ZIP for a simple snapshot, and audio when listening is the better path.

Alex: Exactly. Pick the format that lets you stay oriented, keep moving, and return to the material when you need it.

Workshop Content

Full chapter content from the Git Going with GitHub workshop guide.

Companion Podcast and Transcript

Use audio and transcript companions to review concepts in a conversational format.

Accessing Workshop Materials

Companion audio: this episode reinforces key ideas and may not be a word-for-word reading of this page.

Transcript preview

Alex: Welcome back. Today we're making the workshop materials easier to reach, easier to save, and easier to come back to when you need them.

Jamie: I like this topic because it sounds simple until you're actually trying to find the right file five minutes before an exercise starts.

Alex: Exactly. The same content can show up as Markdown source files, HTML pages, a live website, a local folder on your computer, and even this podcast series. Each format has a different job in your workflow.

Jamie: So there isn't one perfect way to read the workshop. There are a few good doors into the same material.

Appendix Y: Accessing and Downloading Workshop Materials

Listen to Episode 42: Accessing Workshop Materials - a conversational audio overview of this chapter. Listen before reading to preview the concepts, or after to reinforce what you learned.

Reference companion to: Chapter 00: Pre-Workshop Setup

Authoritative source: Community-Access/git-going-with-github

How to Get, Read, and Keep These Documents

Why this appendix exists: The workshop content is available in multiple formats - Markdown source files, pre-built HTML pages, and a live GitHub Pages site. This guide explains how to access each format, download materials for offline use, and keep your copy up to date.

Learning Cards: Accessing Workshop Materials

Screen reader users
  • The GitHub Pages site includes skip-to-content links and ARIA landmarks -- press D (NVDA) or R (JAWS) to jump to the main content landmark on any page
  • On GitHub.com, press T on the repository's main page to open the file finder -- type any filename to jump directly to it without navigating the file tree
  • After cloning the repository, open it in VS Code and use the Explorer panel (Ctrl+Shift+E) to browse the file tree with arrow keys
Low vision users
  • The HTML version in the html/ folder provides the most polished reading experience with styled, navigable pages that work offline in any browser
  • For reading Markdown source files, use VS Code's built-in preview (Ctrl+Shift+V) which renders headings, links, and code blocks in a formatted view
  • When downloading a ZIP from GitHub, the Code button and its dropdown appear near the top of the repository page -- look for the green button
Sighted users
  • Three ways to access materials: GitHub Pages site (online, styled), GitHub.com (browse rendered Markdown), or local clone (offline, editable)
  • The repository's docs/ folder contains all Markdown source files; the html/ folder contains pre-built HTML versions of every page
  • Use git clone for a full copy you can update with git pull -- ZIP downloads are snapshots that do not update automatically

Table of Contents

  1. Browsing Online (GitHub Pages)
  2. Reading on GitHub.com
  3. Downloading Everything
  4. Downloading Individual Files
  5. What's in Each Folder
  6. Offline Reading
  7. Keeping Your Copy Updated
  8. Which Format Should I Use?

1. Browsing Online (GitHub Pages)

If the facilitator has enabled GitHub Pages for this repository, the workshop materials are available as a website at a URL like:

https://<organization>.github.io/Learning-Room/

Your facilitator will share the exact URL. Once you have it:

  1. Open the URL in your browser
  2. The landing page (index.html) is the workshop homepage - equivalent to the README
  3. Use headings (H key in NVDA/JAWS browse mode) to navigate within any page
  4. All internal links between chapters and appendices work - click any cross-reference to go directly to that page
  5. Bookmark the URL for quick access during the workshop

Screen reader tip: The HTML pages include skip-to-content links, breadcrumb navigation, and ARIA landmarks. Press D (NVDA) or R (JAWS) to jump to the main landmark on any page.

For details on how GitHub Pages works, see Appendix P - Publishing with GitHub Pages.

2. Reading on GitHub.com

You can read every file directly on GitHub.com without downloading anything:

  1. Go to the repository page (your facilitator will share the link)
  2. The README renders automatically as the repository homepage
  3. Click into the docs/ folder to see all chapters and appendices
  4. Click any .md file - GitHub renders it as formatted text with headings, links, and code blocks
  • File list: The repository file listing is a grid. Use T to jump to the file table, then arrow keys to navigate rows
  • File content: Once inside a file, GitHub renders the Markdown. Use H to navigate headings
  • Breadcrumbs: At the top of each file view, breadcrumb links show the path (e.g., Learning-Room / docs / 06-working-with-pull-requests.md). Use these to navigate back
  • Go to File shortcut: Press T on the repository's main page to open the file finder - type any filename to jump to it

3. Downloading Everything

Cloning gives you a full copy of the repository that you can update later with git pull:

# Clone the repository
git clone https://github.com/community-access/git-going-with-github.git

# Move into the folder
cd Learning-Room

After cloning, every file (Markdown source, HTML output, scripts, learning-room materials) is on your computer.

Screen reader tip: After cloning, open the folder in VS Code (code .) and use the Explorer panel (Ctrl+Shift+E) to browse the file tree. Press Enter on any file to open it in the editor.

Option B: Download ZIP (no Git required)

If you do not have Git installed or prefer not to use the command line:

  1. Go to the repository page on GitHub.com
  2. Press T to find the file finder, or navigate to the green Code button (it is a dropdown button near the top of the file listing)
  3. Activate the Code button - a dropdown menu opens
  4. Choose Download ZIP
  5. Save the file and extract it to a folder on your computer

Screen reader navigation for the Code dropdown

  • The Code button is near the repository description, after the branch selector
  • In NVDA/JAWS browse mode, press B to jump between buttons until you reach "Code"
  • Activate it with Enter or Space
  • The dropdown contains options including "Download ZIP" - arrow down to find it

Note: A ZIP download is a snapshot. It does not update automatically - see Section 7 for how to get updates.

4. Downloading Individual Files

To download a single file (for example, one chapter or the screen reader cheat sheet):

From GitHub.com

  1. Navigate to the file in the repository
  2. Click the Raw button (it appears above the file content, in the toolbar with "Preview", "Code", "Blame" buttons)
  3. The browser shows the raw file content
  4. Press Ctrl+S (Windows/Linux) or Cmd+S (macOS) to save the page

For HTML files: Navigate to the html/ folder and download the .html version of any file using the same Raw → Save method.

From a cloned repository

If you have already cloned the repo, every file is already on your computer. Open the folder and copy whichever files you need.

5. What's in Each Folder

Folder Contents Format
docs/ All 17 chapters (00-16) and 31 appendices (A-Z, AA-AE) Markdown (.md)
html/ Pre-built HTML versions of every Markdown file HTML (.html)
html/docs/ HTML versions of all chapters and appendices HTML (.html)
learning-room/ Practice repository files: challenges, group exercises, setup guides Markdown (.md)
html/learning-room/ HTML versions of learning-room documents HTML (.html)
.github/ Issue templates, PR template, Copilot agents, slash commands YAML and Markdown
scripts/ Build script that converts Markdown to HTML JavaScript
Root (/) README, agendas, facilitator guide, contributing guide, and other project files Markdown (.md)

6. Offline Reading

Once you have downloaded or cloned the repository, you can read everything offline:

Reading Markdown files

Open .md files in any text editor. They are plain text with lightweight formatting syntax. VS Code renders Markdown with a preview panel (Ctrl+Shift+V).

Reading HTML files

  1. Open html/index.html in any web browser
  2. All internal links between pages work locally - no internet connection required
  3. Navigate between chapters using the links at the bottom of each page

Screen reader tip: The HTML files work the same offline as online. All ARIA landmarks, heading structure, and skip links are embedded in each file.

  • VS Code with Markdown: Open the repo folder in VS Code, browse the Explorer, and read files directly in the editor. Use Ctrl+Shift+V to open the rendered preview
  • Browser with HTML: Open html/index.html and navigate from there - this gives the most polished reading experience

7. Keeping Your Copy Updated

If you cloned with Git

# Navigate to your local copy
cd Learning-Room

# Pull the latest changes
git pull

If you have not made local changes, this updates your copy cleanly. If you have local edits, Git will attempt to merge - see Chapter 7 - Merge Conflicts if needed.

After pulling, rebuild the HTML to ensure it matches:

npm run build:html

If you downloaded a ZIP

Download a fresh ZIP from the repository and replace your local copy. There is no incremental update for ZIP downloads.

8. Which Format Should I Use?

Need Best format Why
Reading during the workshop GitHub Pages (online HTML) No setup, always current, fully accessible
Offline reference Local HTML (html/ folder) Works in any browser, no internet needed, styled and navigable
Editing or contributing Markdown (.md files) The source format - edit these, then rebuild HTML
Quick lookup of one section GitHub.com Navigate directly in the browser, no download
Archiving a copy ZIP download or Git clone Full snapshot of all materials
Staying updated long-term Git clone One-command updates with git pull

Learning Cards: Choosing the Right Format

Screen reader users
  • For workshop use, the GitHub Pages HTML site is the most accessible option -- it includes skip links, landmarks, and proper heading structure in every page
  • For offline reference, the local HTML files in the html/ folder work identically to the online version with full navigation between pages
  • For contributing edits, work with the Markdown source files in docs/ using VS Code -- these are the canonical source that generates everything else
Low vision users
  • GitHub Pages and local HTML both support browser zoom to 200%+ without layout breakage -- use whichever gives you a better reading experience
  • VS Code's Markdown preview inherits your editor theme -- if you use a high-contrast theme, the preview will match
  • If viewing on GitHub.com, enable GitHub's dark theme (Settings then Appearance) for reduced eye strain during long reading sessions
Sighted users
  • Use the GitHub Pages site during the workshop for the most polished, hyperlinked reading experience with no setup required
  • Clone the repository for a permanent offline copy -- the html/index.html file serves as a local homepage linking to all content
  • The Markdown source in docs/ is what you edit to contribute improvements -- changes are rebuilt to HTML automatically via the GitHub Actions workflow

Next: Appendix Z: GitHub Skills
Back: Appendix X: Resources
Teaching chapter: Chapter 00: Pre-Workshop Setup

Authoritative Sources

Use these official references when you need the current source of truth for facts in this chapter.

Section-Level Source Map

Use this map to verify facts for each major section in this file.