Skip to content

Commit

Permalink
Modifies examples to include a single heading
Browse files Browse the repository at this point in the history
This is done to have files with a single heading as accessibility
recommendations. A title is introduced (recipe title) and the
ingredients and instructions are set as 2nd level headings.
  • Loading branch information
dpshelio committed Aug 14, 2024
1 parent 2c983e7 commit 50338c8
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 52 deletions.
44 changes: 26 additions & 18 deletions episodes/04-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ $ nano guacamole.md
Type the text below into the `guacamole.md` file:

```output
# Ingredients
# Instructions
# Guacamole
## Ingredients
## Instructions
```

Let's first verify that the file was properly created by running the list command (`ls`):
Expand All @@ -61,8 +62,9 @@ $ cat guacamole.md
```

```output
# Ingredients
# Instructions
# Guacamole
## Ingredients
## Instructions
```

If we check the status of our project again,
Expand Down Expand Up @@ -201,11 +203,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lemon
- salt
# Instructions
## Instructions
```

When we run `git status` now,
Expand Down Expand Up @@ -246,12 +249,13 @@ diff --git a/guacamole.md b/guacamole.md
index df0654a..315bf3a 100644
--- a/guacamole.md
+++ b/guacamole.md
@@ -1,2 +1,5 @@
# Ingredients
@@ -1,3 +1,6 @@
# Guacamole
## Ingredients
+- avocado
+- lemon
+- salt
# Instructions
## Instructions
```

The output is cryptic because
Expand Down Expand Up @@ -357,11 +361,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
```

```bash
Expand All @@ -373,13 +378,14 @@ diff --git a/guacamole.md b/guacamole.md
index 315bf3a..b36abfd 100644
--- a/guacamole.md
+++ b/guacamole.md
@@ -1,5 +1,5 @@
# Ingredients
@@ -1,6 +1,6 @@
# Guacamole
## Ingredients
- avocado
-- lemon
+- lime
- salt
# Instructions
## Instructions
```

So far, so good:
Expand Down Expand Up @@ -409,13 +415,14 @@ diff --git a/guacamole.md b/guacamole.md
index 315bf3a..b36abfd 100644
--- a/guacamole.md
+++ b/guacamole.md
@@ -1,5 +1,5 @@
# Ingredients
@@ -1,6 +1,6 @@
# Guacamole
## Ingredients
- avocado
-- lemon
+- lime
- salt
# Instructions
## Instructions
```

it shows us the difference between
Expand Down Expand Up @@ -694,7 +701,8 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado (1.35)
- lime (0.64)
- salt (2)
Expand Down
47 changes: 27 additions & 20 deletions episodes/05-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
An ill-considered change
```

Expand All @@ -54,10 +55,10 @@ diff --git a/guacamole.md b/guacamole.md
index b36abfd..0848c8d 100644
--- a/guacamole.md
+++ b/guacamole.md
@@ -3,3 +3,4 @@
@@ -4,3 +4,4 @@
- lime
- salt
# Instructions
## Instructions
+An ill-considered change
```

Expand All @@ -83,12 +84,13 @@ diff --git a/guacamole.md b/guacamole.md
index df0654a..b36abfd 100644
--- a/guacamole.md
+++ b/guacamole.md
@@ -1,2 +1,5 @@
# Ingredients
@@ -1,3 +1,6 @@
# Guacamole
## Ingredients
+- avocado
+- lime
+- salt
# Instructions
## Instructions
```

We could also use `git show` which shows us what changes we made at an older commit as
Expand All @@ -111,9 +113,10 @@ new file mode 100644
index 0000000..df0654a
--- /dev/null
+++ b/guacamole.md
@@ -0,0 +1,2 @@
+# Ingredients
+# Instructions
@@ -0,0 +1,3 @@
+# Guacamole
+## Ingredients
+## Instructions
```

In this way,
Expand Down Expand Up @@ -144,12 +147,13 @@ diff --git a/guacamole.md b/guacamole.md
index df0654a..93a3e13 100644
--- a/guacamole.md
+++ b/guacamole.md
@@ -1,2 +1,5 @@
# Ingredients
@@ -1,3 +1,7 @@
# Guacamole
## Ingredients
+- avocado
+- lime
+- salt
# Instructions
## Instructions
+An ill-considered change
```

Expand All @@ -166,12 +170,13 @@ diff --git a/guacamole.md b/guacamole.md
index df0654a..93a3e13 100644
--- a/guacamole.md
+++ b/guacamole.md
@@ -1,2 +1,5 @@
# Ingredients
@@ -1,3 +1,7 @@
# Gucamole
## Ingredients
+- avocado
+- lime
+- salt
# Instructions
## Instructions
+An ill-considered change
```

Expand Down Expand Up @@ -208,11 +213,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
```

As you might guess from its name,
Expand All @@ -232,8 +238,9 @@ $ cat guacamole.md
```

```output
# Ingredients
# Instructions
# Guacamole
## Ingredients
## Instructions
```

```bash
Expand Down
5 changes: 3 additions & 2 deletions episodes/08-collab.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ $ cat hummus.md
```

```output
# Ingredients
# Hummus
## Ingredients
- chickpeas
- lemon
- olive oil
Expand All @@ -90,7 +91,7 @@ $ git commit -m "Add ingredients for hummus"
```

```output
1 file changed, 5 insertion(+)
1 file changed, 6 insertion(+)
create mode 100644 hummus.md
```

Expand Down
30 changes: 18 additions & 12 deletions episodes/09-conflict.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
```

Let's add a line to the collaborator's copy only:
Expand All @@ -48,11 +49,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
- put one avocado into a bowl.
```

Expand Down Expand Up @@ -94,11 +96,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
- peel the avocados
```

Expand Down Expand Up @@ -207,11 +210,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
<<<<<<< HEAD
- peel the avocados
=======
Expand All @@ -237,11 +241,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
- peel the avocados and put them into a bowl.
```

Expand Down Expand Up @@ -321,11 +326,12 @@ $ cat guacamole.md
```

```output
# Ingredients
# Guacamole
## Ingredients
- avocado
- lime
- salt
# Instructions
## Instructions
- peel the avocados and put them into a bowl.
```

Expand Down

0 comments on commit 50338c8

Please sign in to comment.