READ(L)ME This, _{^{How does one host a resume using GitHub-Pages?}} 🤨

Contents Table 📂

• Prerequisites
• Steps
  1. Software Installation
  2. Setting up GitHub-Pages
  3. Setting-Up Local Repository
  4. Create Default Files With Git Bash
  5. Test Site
  6. Adding Resume
  7. Modify _config.yml
  8. Modify Gemfile
  9. Push To Main
  10. Lets See The Result!
• More Resources
• Credits
• FAQ

Prerequisites ❗

• Prior to starting this tutorial you should already have a resume that is in Markdown format. If you don't have one I recommend checking out the Markdown Tutorial in the More Resources.

---

Steps 👣

1. Software Installation

1. Download GitHub Desktop
2. Download Ruby
3. Download Visual Studio Code

2. Setting-Up GitHub-Pages

^{Note: using a Distributed Version Control System (Like GitHub) is a great way to share and host your files. You can learn more on page 28 of Modern Technical Writing, By Andrew Etter.}

1. Navigate to your repositories (github.com/yourUsername?tab=repositories).
2. Click on the green button that says New.

3. Type yourUsername.github.io into the text box labelled Repository name.
4. Check-off the box labelled Add a README file.
5. Click the green button labelled Create repository.

3. Setting-Up Local Repository

1. Navigate to your newly created repository (github.com/yourUsername/yourUsername.github.io).
2. Click on the green button that says Code.
3. Click Open with GitHub Desk -- (Note: a popup may arise, if so, just click Open GitHubDesktop.exe).

4. Click the blue button labelled Clone once the GitHub Desktop application opens up -- (Note: keep track of the Local path you are cloning to. This will be required in an upcoming step).

4. Create Default Files With Git Bash

1. Open the Git Bash terminal.
2. Navigate to the Local path where your repository was cloned. This is an example of how to navigate files in a terminal with the cd command, cd 'C:\Users\yourAccount\Documents\GitHub\yourUsername.github.io'.
3. Type the command gem install jekyll bundler.

5. Test Site

^{Note: Setting up a Static Site Generator (What we completed in the prior step) is one of the best things you can do to save time for future you! With a properly configured Static Site Generator you'll be able to pass it brand new Markdown files and have it automatically generate a delightful site. If you're interested in knowing more I recommend reading pages 31 to 33 of Modern Technical Writing, By Andrew Etter.}

1. Open the Git Bash terminal.
2. Navigate to the Local path where your repository was cloned. This is an example of how to navigate files in a terminal with the cd command, cd 'C:\Users\yourAccount\Documents\GitHub\yourUsername.github.io'.
3. Type the command bundle exec jekyll serve.
4. Wait till the terminal says Server running... press ctrl-c to stop.
5. Type http://localhost:4000/ into your browser.
6. Once the page is loaded you should see your site.
7. Close the site by pressing ctrl-c, followed by Y and the enter key in the Git Bash terminal.

6. Adding Resume

1. Open GitHub Desktop.
2. Press Ctrl+Shift+A (Visual Studio Code should open).
3. Open index.markdown, found under the EXPLORER tab (Note: If you don't see the EXPLORER tab press Ctrl+B).
4. Paste your pre-existing resume into the index.markdown file.
5. Save the file.

7. Modify _config.yml

1. Open _config.yml.
2. Comment-out every line. (Note: To comment-out a line place # at the start).
3. Add the following
   • remote_theme: pages-themes/[email protected]
   • plugins:
   • - jekyll-remote-theme
4. Save the file.

8. Modify Gemfile

1. Open Gemfile.
2. Comment-out the following:
   • gem "jekyll", "~> 4.3.2"
   • gem "minima", "~> 2.5"
   • gem "jekyll-feed", "~> 0.12"
3. Add gem "slate", "~> 0.2.0" above #gem "minima", "~> 2.5".
4. Add gem "jekyll-remote-theme" above #gem "jekyll-feed", "~> 0.12".
5. Save the file.

9. Push To Main

1. Open GitHub Desktop.
2. Write a Summary of what you've completed so far, in text box labelled Summary (required).
3. Click the blue button labelled Commit to main.

10. Let's See The Result!

1. Navigate to your repository (github.com/yourUsername/yourUsername.github.io).
2. Click the Actions tab.
3. Wait until there is a green check mark next to the latest pages build and deployment.

4. Click the <>Code tab.
5. Click the github-pages button, located on the right side of the page under Environments.
6. Click View deployment on the right hand side of the page.
7. Congradulations! You now have your personal resume hosted on GitHub Pages! If you wish to go further and make more amazing projects I recommend you check out some of the resources and credits below, Cheers!🎉

---

More Resources 📚

• Markdown
  • Markdown Tutorial (Start Here)
  • Basic Markdown Cheatsheet (Usefull)
  • Advanced GitHub Flavored Markdown Cheatsheet (Extra)
• Modern Technical Writing, By Andrew Etter
• GitHub Pages

---

Credits 📜

• Modern Technical Writing, By Andrew Etter
• Jekyll Docs
• GitHub's Jekyll Docs
• Jekyll Slate Theme
• Adobe Convert to GIF

---

FAQ ❓

• Q: Why is Markdown better than a word processor?
  • A: Most static site generators use Markdown files as inputs, because of this it makes it easy to update a static sites content without needed to rewrite any HTML or CSS, saving you much time.
• Q: Why is my resume not showing up?
  • A: It could be that your GitHub-Page is still being built. Open your repository and click the Actions tab. Under the workflow runs if you see any orange circle or text saying queued then your GitHub-Page is still being built.
  • Solution: Leave it running for 5-10 minutes and comeback.
• Q: What is a lightweight markup language?
  • A: A lightweight markup language is what Technical Writers use tipically when writing documents, it allows writers to format their document without the use of special programs or charaters. Markdown is one of these lightweight markup languages. If your intrested in learning more I reccoment reading Modern Technical Writing, By Andrew Etter