From 6fb444458187467de3ad04889137be8d6833b854 Mon Sep 17 00:00:00 2001 From: Eric Earl Date: Thu, 15 Nov 2018 07:48:33 -0800 Subject: [PATCH 1/2] Update tutorial.Rmd Quickly added email addresses to all authors for consistency. --- beginner/tutorial.Rmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/beginner/tutorial.Rmd b/beginner/tutorial.Rmd index c43b289..149ecf6 100644 --- a/beginner/tutorial.Rmd +++ b/beginner/tutorial.Rmd @@ -1,6 +1,6 @@ --- title: "Github Pages Tutorial" -author: "Ted Laderas (laderast@ohsu.edu), Eric Leung, Robin Champieux (champieu@ohsu.edu), Eric Earl, and Marijane White" +author: "Ted Laderas (laderast@ohsu.edu), Eric Leung (leunge@ohsu.edu), Robin Champieux (champieu@ohsu.edu), Eric Earl (earl@ohsu.edu), and Marijane White (whimar@ohsu.edu)" date: "`r Sys.Date()`" output: html_document: From 4cd8c5ed2170dcd26a1716a4de2efeb5de300a2b Mon Sep 17 00:00:00 2001 From: Eric Earl Date: Thu, 15 Nov 2018 07:53:03 -0800 Subject: [PATCH 2/2] Update docs/index.html Published Robin's edits from Rmd to HTML. --- docs/index.html | 78 +++++++++++++++++++++++++------------------------ 1 file changed, 40 insertions(+), 38 deletions(-) diff --git a/docs/index.html b/docs/index.html index e8d3dfa..d105efd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -9,9 +9,9 @@ - + - + Github Pages Tutorial @@ -123,8 +123,8 @@

Github Pages Tutorial

-

Ted Laderas (laderast@ohsu.edu), Eric Leung, Robin Champieux, Eric Earl, and Marijane White

-

2018-11-12

+

Ted Laderas (laderast@ohsu.edu), Eric Leung (leunge@ohsu.edu), Robin Champieux (champieu@ohsu.edu), Eric Earl (earl@ohsu.edu), and Marijane White (whimar@ohsu.edu)

+

2018-11-15

@@ -140,9 +140,9 @@

2018-11-12

  • Rename the Repo
  • Editing the Name of Your Webpage and Customizing
  • Look at your new website!
    • -
  • Make content using Markdown
    • +
  • Make Content Using Markdown
  • Markdown Basics
    • -
  • Let’s Add Some Links
    • +
  • Let’s Update Your Home Page (Index) And Add Some Links
  • Let’s Add an Image (from an external website)
  • Uploading images to your website and using them
  • Add a Blog Entry
    • @@ -171,13 +171,13 @@

    What is GitHub Pages?

    Why GitHub Pages?

    -

    GitHub is a highly dependable webhost, and you get one personal webpage account for free.

    +

    GitHub is a highly dependable webhost, and you get one personal webpage account for free. Plus, if you move institutions, your website can travel with you.

    Because GitHub pages is compatible with Markdown, we’ll be using Markdown formatting to build our webpage.

    Our goal for the day

    -

    We’re going to build a personal webpage which will live at USERNAME.github.io, and have blogging features and will be easily customizable.

    -

    There’s an example of a blog here: https://laderast.github.io/academic_site_workshop/

    +

    We’re going to build a personal webpage which will live at USERNAME.github.io. The template we’re using, Jekyll Academic, was developed by NCSU Libraries and is tailored specifically for use within the academic community.

    +

    There is a live example of the template here: https://laderast.github.io/academic_site_workshop/. You’ll be able to customize many elements, including the color scheme.

    What You Need for Today

    @@ -185,8 +185,12 @@

    What You Need for Today

    • A Laptop
    • A GitHub Account
      • -
    • Content like your bio, C.V., or a blog post
      • -
    • Pictures (optional)
      • +
    +

    Additionally, it will be helpful to have the following on hand so you can add content to your new website:

    +
      +
    • A short bio
      • +
    • A headshot or another image that represents your professional interests
      • +
    • A C.V. or resume

    You may want to spend a little time learning how to use markdown, as it’ll make putting your content together faster. There is a tutorial here: The Magic of Markdown that will get you started with the basics. We’ll give you just enough to get started.

    @@ -194,8 +198,8 @@

    What You Need for Today

    What We’re Going to do Today

    1. Fork the repository
      2. -
    2. Rename the repo(sitory)
      3. -
    3. Change and personalize Your website with YAML
      4. +
    4. Rename the repository
      5. +
    5. Change and personalize your website with YAML
    6. Look at your new website!
    7. Start editing content with Markdown
    8. Add links
      9. @@ -209,11 +213,11 @@

      What We’re Going to do Today

      Fork the Repo(sitory) From GitHub

      Log into your GitHub account. Now go to the website repo: https://github.com/laderast/academic_site_workshop and click the “Fork” button on the top right of the webpage.

      -

      When we fork we’re copying the files into our own version of the repository. Basically we’ll use the above link as the basis of our website.

      +

      When we fork we’re copying the files into our own repository. We’ll use the copy as the building block for your new website.

      A little bit about Jekyll

      -

      Jekyll is what’s known as a static site generator. It will build a website from simpler text files that are in Markdown. Markdown is much easier to work with, since you don’t have to worry about adding HTML tags and accidentally breaking it.

      +

      Jekyll is what’s known as a static site generator. It will build a website from simple text files that are in Markdown. Markdown is much easier to work with, since you don’t have to worry about adding HTML tags and accidentally breaking it.

      The other nice thing about Jekyll is that it will integrate things like Google Analytics, Tags, and search into your website structure.

      Jekyll is built into GitHub, so we just need to edit the files in our repository to have GitHub automatically build the webpage.

      Here’s a little picture of the file structure of our website and what we’ll do to modify it.

      @@ -228,10 +232,11 @@

      Rename the Repo

      Editing the Name of Your Webpage and Customizing

      -

      The first step to customizing your webpage is to edit the blog’s name to include your information. To do this, you will be editing a YAML file, which is a simple configuration file. You’ll open the _config.yml file in the root level of your repo to update the info here. In GitHub, click on the _config.yml file, and then edit it (it’s the pencil button on the right).

      -

      Change the title, name, bio, email, and the social media fields (such as twitter, linkedin) with your information.

      +

      The first step to creating your website is to edit the information in the YAML file. This is a simple configuration file where some important settings for your site are stored.

      +

      You’ll find the _config.yml file in the root (parent) level of your repo. In GitHub, click on the _config.yml file. To edit it click on the pencil button on the right.

      +

      Update the title, name, bio, email, and the social media fields (such as twitter, linkedin) with your information.

      Just make you that you don’t modify anything below #DO NOT EDIT BEYOND THIS POINT.

      -

      Here’s an example _config.yml file. Don’t worry about the avatar and the logo file for right now. # symbols are the beginning of “comments” which are ignored in YAML files to the right of the # symbol.

      +

      Here’s an example _config.yml file. Don’t worry about the avatar and the logo file for right now. # symbols are the beginning of comments. The text to the right of the # symbol is ignored.

      # Site wide configuration
 
 title: Academic Website of Ted Laderas
@@ -256,36 +261,32 @@ 
      Editing the Name of Your Webpage and Customizing
      
     analytics:
     verify:
     scholar: #id
      -

      After you have edited your _config.yml file, click the green “Commit changes” button at the bottom of the page. That will save the file to your repository.

      +

      After you have edited your _config.yml file, click the green “Commit changes” button at the bottom of the page, which will save the file to your repository.

      Look at your new website!

      -

      You’re ready to go! Now check out your initialized website at https://USERNAME.github.io. We’ll start customizing it!

      +

      You’re ready to go! Now check out your initialized website at https://USERNAME.github.io. Next we’ll start customizing it!

      -

      Make content using Markdown

      +

      Make Content Using Markdown

      We’ll be adding our content by using Markdown Files. Markdown is a lightweight way to format text that is much easier to manipulate than working with HTML files directly.

      -

      GitHub has a “translation engine” that will transform and format your Markdown files for the website to make them browser-friendly.

      -

      This means you can concentrate on making content rather than obsessing about every little site detail.

      +

      GitHub has a “translation engine” that will transform and format your Markdown files for the website, making them browser friendly.

      +

      This means you can concentrate on making content rather than obsessing about every little site detail!

      Markdown Basics

      -

      A markdown file generally has a .md or a .markdown extension. Let’s open the file in _posts/2012-02-07-example-content.md in GitHub and you’ll see some examples of how to write in markdown.

      +

      A markdown file generally has a .md or a .markdown extension. It uses plain text formatting syntax, which is pretty easy to learn. For example, bulleted lists are denoted with an asterix before each line item and subheadings with one or more hash marks.

      +

      This markdown cheatsheet is handy to learn how to do things. https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf

      Way more info about writing markdown can be found here: https://github.com/laderast/magic-of-markdown

      -

      And this markdown cheatsheet is always handy if you forget how to do things. https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf

      -

      Try changing the cv.md file with your info (remember to click the edit pencil button). When you’re done, click the green “Commit changes” button at the bottom to save your changes.

      +

      Try editing the cv.md file with your info (remember to click the edit pencil button). When you’re done, click the green “Commit changes” button at the bottom to save your changes.

      Reload your website to make sure that the changes worked. It sometimes takes a little time for GitHub to update the files, so be patient if they don’t appear immediately.

      -