Skip to content

Commit dba8855

Browse files
Update to 2 in STEP and README.md
1 parent ac8be53 commit dba8855

File tree

2 files changed

+14
-36
lines changed

2 files changed

+14
-36
lines changed

.github/steps/-step.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1
1+
2

README.md

Lines changed: 13 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,55 +14,33 @@ _Organize ideas and collaborate using Markdown, a lightweight language for text
1414
</header>
1515

1616
<!--
17-
<<< Author notes: Step 1 >>>
18-
Choose 3-5 steps for your course.
19-
The first step is always the hardest, so pick something easy!
20-
Link to docs.github.com for further explanations.
21-
Encourage users to open new tabs for steps!
17+
<<< Author notes: Step 2 >>>
18+
Start this step by acknowledging the previous step.
19+
Define terms and link to docs.github.com.
2220
-->
2321

24-
## Step 1: Add headers
22+
## Step 2: Add an image
2523

26-
_Welcome to "Communicate using Markdown"! :wave:_
24+
_Great job adding headers to the file :sparkles:_
2725

28-
**What is _Markdown_?** Markdown is a [lightweight syntax](https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for communicating on GitHub. You can format text to add a heading, lists, **bold**, _italics_, tables, and many other stylings. You can use Markdown in most places around GitHub:
29-
30-
- Comments on [issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues), [pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests), and [discussions](https://docs.github.com/discussions/collaborating-with-your-community-using-discussions/about-discussions)
31-
- Files with the `.md` or `.markdown` extension
32-
- Sharing snippets of text in [Gists](https://docs.github.com/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)
33-
34-
**What is a _header_?** A header is a larger bit of text at the beginning of a section. There are six sizes.
26+
Let's add an image. Include descriptive text in the square brackets. This text is read aloud for people using screen readers. It's also shown at times when your image doesn't display, such as when there's a poor connection. You can see the syntax for images below:
3527

3628
### Example
3729

3830
```md
39-
# This is an `<h1>` header, which is the largest
40-
41-
## This is an `<h2>` header
42-
43-
###### This is an `<h6>` header, which is the smallest
31+
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
4432
```
4533

4634
#### How it looks
4735

48-
# This is an `<h1>` header, which is the largest
49-
50-
## This is an `<h2>` header
51-
52-
###### This is an `<h6>` header, which is the smallest
36+
<img alt="Image of Yaktocat" src=https://octodex.github.com/images/yaktocat.png width=400>
5337

54-
### :keyboard: Activity: Edit your file with headers
38+
### :keyboard: Activity: Adding an image
5539

56-
1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
57-
1. Open the **pull requests** tab.
58-
1. Click **New pull request**, for the branches to compare, select `base: main` and `compare: start-markdown`.
59-
1. Click **Create pull request**.
60-
1. In this pull request, go to the **Files changed** tab. We made an empty file `index.md` for you.
61-
1. Select **Edit file** from the three dotted **...** menu in the upper right corner of the file view on `index.md`.
62-
1. On the **Edit file** tab, add a `#`, followed by a **space**, before any content you like to make it an H1 Header. You can add more headers, using one to six `#` characters followed by a **space**.
63-
1. Above your new content, click **Preview**.
64-
1. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file.
65-
1. Click **Commit changes**.
40+
1. As you did before, edit the `index.md` file in this pull request.
41+
1. In the file, add the correct Markdown for your image of choice. Don't forget to include alt-text!
42+
1. Use the **Preview** tab to check your Markdown formatting.
43+
1. Commit your changes.
6644
1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.
6745

6846
<footer>

0 commit comments

Comments
 (0)