Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ernestguevarra committed Jun 8, 2020
0 parents commit dd03a62
Show file tree
Hide file tree
Showing 6 changed files with 755 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata
.DS_Store
Binary file added figures/webSample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions markdownTutorial.Rproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Version: 1.0

RestoreWorkspace: Default
SaveWorkspace: Default
AlwaysSaveHistory: Default

EnableCodeIndexing: Yes
UseSpacesForTab: Yes
NumSpacesForTab: 2
Encoding: UTF-8

RnwWeave: Sweave
LaTeX: pdfLaTeX
178 changes: 178 additions & 0 deletions markdown_tutorial_3EE.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
---
title: "Learning Markdown"
subtitle: "A short tutorial for Class 3EE"
author: "Ernest Guevarra"
date: '`r Sys.Date()`'
output:
xaringan::moon_reader:
lib_dir: libs
css: xaringan-themer.css
nature:
highlightStyle: github
highlightLines: true
countIncrementalSlides: false
---

```{r setup, include=FALSE}
options(htmltools.dir.version = FALSE)
```

```{r xaringan-themer, include=FALSE, warning=FALSE}
library(xaringanthemer)
style_duo_accent(
primary_color = "#1381B0",
secondary_color = "#FF961C",
inverse_header_color = "#FFFFFF"
)
```

# What is Markdown?

* Is a lightweight markup language that you can use to add formatting elements to plaintext text documents

* Created by John Gruber in 2004

* Is now one of the world’s most popular markup languages

* It is used to make different types of documents including websites, notes, books, presentations, email, and documentation

* This presentation was created using a type of Markdown

---

.pull-left[

### This is an example of a Markdown of a page in the Class 3EE website

```MD
Dear parents

This week, in Spanish, we will be
looking at the following:

* **Spanish:** synonyms

* **Reading:** We will start reading
the book "para hacer un pastel de
manzana" and Clara's farm story.

* **DoW:** Where food comes from and
farm animals.

* **Maths:** Divisions

* **Art:** Craft "make your farm"

Thanks

Sofia
```
]

.pull-right[

### This is how it looks like on the actual Class 3EE website

![](figures/webSample.png)
]

---

# What do you notice with the Markdown document compared to the final output document?

* Except for very minor differences in some characters such as the asterisk or star used in Markdown, the Markdown document is exactly the same text as is the website output

* This is one of the really cool features of Markdown - its **human-readable format**

* This also gives you an idea of how easy it is to write your newspaper articles using Markdown

---

class: center, middle

## Are you ready to write your newpaper articles in Markdown?

---

class: center, middle

## In this tutorial, we will learn how to convert the newspaper articles that you created for English class into Markdown to prepare it for publication into the online newspaper created for this project

---

# What you will need

* A copy of your newspaper article or articles submitted to Mrs Trevitt

* A computer/device that you use for home school. This device should have access to your Google for Education account from school. Specifically, we will use **Google Docs**

---

# Step 1: Open a blank document in **Google Docs**

* When writing Markdown, you usually use what is called a **text editor** - an application on your computer that you use to write plain text

* **Google Docs** is not considered a plain text editor

* However, because most of you have already been using **Google Docs** for home school, we will use it for creating your Markdown document

* Once you have written the Markdown version of your newspaper article in **Google Docs**, we will output this document from **Google Docs** into a text file. A text file is a file with an extension `.txt`

---

# Step 2: Writing the front matter

* A Markdown document usually has what is called a **front matter** at the start

* The **front matter** provides information regarding the document you are writing

* The **front matter** looks something like this:

```MD
---
title: Missing sausage dog found using bacon
author: Jane Doe
date: "2020-06-08"
---
```

* In this example **front matter**, the `title`, the `author`, and the `date` of the document are included.

* Depending on the document you are writing, other information are included in the **front matter**

---

# Step 2: Writing the front matter

* The **front matter** should always be at the start of the document.

* The **front matter** should always be written sandwiched between three dashes at the start and three dashes at the end:

```MD
---
FRONT MATTER HERE
---
```

* For the newspaper articles we are writing, we need the following information to be included in the front matter:

```MD
---
title: TITLE OF YOUR NEWSPAPER ARTICLE
author: YOUR NAME (OR A PSEUDONYM INSTEAD OF YOUR REAL NAME)
date: DATE WHEN YOU WROTE THE NEWSPAPER ARTICLE
---
```
---

class: center, middle

## You can now start writing the front matter for your newspaper article in the **Google Docs** you opened

---

# Step 3: Write your newspaper article

* This is probably the easiest step in the process

* Most of you have written your newspaper articles using **Google Docs** already
Loading

0 comments on commit dd03a62

Please sign in to comment.