Day 01 on GAMbler

A GitHub profile

Fri, 01 Jan 2021 00:00:00 +0000

Profile

https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/personalizing-your-profile

Pin projects to profile

https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile

Profile README

This is new! Let’s do it:

https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme

A postcard

Sat, 02 Jan 2021 00:00:00 +0000

Pre-requisites

First, make sure you have the latest version of the postcards package installed from CRAN:

install.packages("postcards")

Restart your R session. If you use RStudio, use the menu item Session > Restart R or the associated keyboard shortcut:

Ctrl + Shift + F10 (Windows and Linux) or
Command + Shift + F10 (Mac OS).

packageVersion("postcards")
[1] ‘0.2.0’

Create GitHub repo

Online.

Clone GitHub repo

usethis::create_from_github("https://github.com/apreshill/global-postcard.git")

✨ Commit & Push! ✨

You should be committing these files:

*.Rproj
.gitignore

Create a postcard

Inside your current postcards project, use the R console:

library(postcards)

Then you could run (wait- don’t do this yet!):

create_postcard()

But you could also pick one of four templates:

"jolla" ( https://seankross.com/postcards-templates/jolla/) [the default]
"jolla-blue" ( https://seankross.com/postcards-templates/jolla-blue/)
"trestles" ( https://seankross.com/postcards-templates/trestles/)
"onofre" ( https://seankross.com/postcards-templates/onofre/)

create_postcard(template = "jolla") #default
create_postcard(template = "jolla-blue")
create_postcard(template = "trestles")
create_postcard(template = "onofre")

Anatomy of a postcard

YAML, body, name is index- this is special

✨ Commit & Push! ✨

You should be committing these files:

index.Rmd
*.jpg

But! There is no .html file (yet…)

Knit the postcard

Knit button or

rmarkdown::render("index.Rmd")

What is new in your Git pane?

✨ Commit & Push! ✨

You should be committing this files:

index.html

(You may get a warning in RStudio IDE that this file is too big- go right ahead)

Publish a postcard

Easy:

Push, publish to GitHub pages https://docs.github.com/en/github/working-with-github-pages/creating-a-github-pages-site#creating-your-site

Medium:

> use_github_pages(branch = "main", path = "/")
✓ Setting active project to '/Users/alison/rscratch/global-postcard'
✓ Activating GitHub Pages for 'apreshill/global-postcard'
✓ GitHub Pages is publishing from:
● URL: 'https://apreshill.github.io/global-postcard/'
● Branch: 'main'
● Path: '/'

Add it to your repository details

A distill site

Sat, 02 Jan 2021 00:00:00 +0000

Pre-requisites

First, make sure you have the latest version of the distill package installed from CRAN:

install.packages("distill")

Restart your R session. If you use RStudio, use the menu item Session > Restart R or the associated keyboard shortcut:

Ctrl + Shift + F10 (Windows and Linux) or
Command + Shift + F10 (Mac OS).

packageVersion("distill")
# [1] ‘1.2’

Create GitHub repo

Online.

Clone GitHub repo

usethis::create_from_github("https://github.com/apreshill/global-distill.git")

✨ Commit & Push! ✨

You should be committing these files:

*.Rproj
.gitignore

Create a new distill site

Inside your current distill project, use the R console:

library(distill)

Let’s start with a simple website:

create_website(dir = ".", title = "global-distill", gh_pages = TRUE)

Now, let’s commit all these new files and push to GitHub.

Build site

Please close the RStudio IDE and re-open it. Look in your Git pane, you should see a single file has changed:

Let’s look at the diff:

Let’s go ahead and commit this file before we start adding to our site.

You should see:

Add a postcard

Docs: https://rstudio.github.io/distill/website.html#postcards

Now, delete your about.Rmd (trust me!). We’ll create a new one with the postcards package.

create_article(file = "about",         # future name of .Rmd file
               template = "jolla",    # name of template
               package = "postcards")

Reminder: templates

_site.yml

Theme

Docs: https://rstudio.github.io/distill/website.html#theming

distill::create_theme("apreshill")

Remember your _site.yml file? Add the theme line there:

name: "Alison Hill"
title: "Personal website of Dr. Alison Hill"
description: |
  This is my personal website.
output_dir: "docs"
theme: apreshill.css
navbar:
  right:
    - text: "Home"
      href: index.html
    - text: "About"
      href: about.html
output: distill::distill_article

Publish a distill site

Easy:

Push, publish to GitHub pages https://docs.github.com/en/github/working-with-github-pages/creating-a-github-pages-site#creating-your-site

Medium:

> use_github_pages(branch = "main", path = "/docs")
✓ Setting active project to '/Users/alison/rscratch/global-distill'
✓ Activating GitHub Pages for 'apreshill/global-distill'
✓ GitHub Pages is publishing from:
● URL: 'https://apreshill.github.io/global-distill/'
● Branch: 'main'
● Path: '/docs'

Day 01 on GAMbler

A GitHub profile

Profile

Pin projects to profile

Profile README

A postcard

Pre-requisites

Create GitHub repo

Clone GitHub repo

Create a postcard

Anatomy of a postcard

Knit the postcard

Publish a postcard

Share your postcard!

A distill site

Pre-requisites

Create GitHub repo

Clone GitHub repo

Create a new distill site

Build site

Add a postcard

Site navigation

Theme

Publish a distill site