|
| 1 | +<!-- |
| 2 | + <<< Author notes: Step 1 >>> |
| 3 | + Choose 3-5 steps for your course. |
| 4 | + The first step is always the hardest, so pick something easy! |
| 5 | + Link to docs.github.com for further explanations. |
| 6 | + Encourage users to open new tabs for steps! |
| 7 | +--> |
| 8 | + |
| 9 | +## Step 1: Add headers |
| 10 | + |
| 11 | +_Welcome to "Communicate using Markdown"! :wave:_ |
| 12 | + |
| 13 | +**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: |
| 14 | + |
| 15 | +- 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) |
| 16 | +- Files with the `.md` or `.markdown` extension |
| 17 | +- Sharing snippets of text in [Gists](https://docs.github.com/github/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) |
| 18 | + |
| 19 | +**What is a _header_?** A header is a larger bit of text at the beginning of a section. There are six sizes. |
| 20 | + |
| 21 | +### Example |
| 22 | + |
| 23 | +```md |
| 24 | +# This is an `<h1>` header, which is the largest |
| 25 | + |
| 26 | +## This is an `<h2>` header |
| 27 | + |
| 28 | +###### This is an `<h6>` header, which is the smallest |
| 29 | +``` |
| 30 | + |
| 31 | +#### How it looks |
| 32 | + |
| 33 | +# This is an `<h1>` header, which is the largest |
| 34 | + |
| 35 | +## This is an `<h2>` header |
| 36 | + |
| 37 | +###### This is an `<h6>` header, which is the smallest |
| 38 | + |
| 39 | +### :keyboard: Activity: Edit your file with headers |
| 40 | + |
| 41 | +1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab. |
| 42 | +1. Open the **pull requests** tab. |
| 43 | +1. Click **New pull request**, for the branches to compare, select `base: main` and `compare: start-markdown`. |
| 44 | +1. Click **Create pull request**. |
| 45 | +1. In this pull request, go to the **Files changed** tab. We made an empty file `index.md` for you. |
| 46 | +1. Select **Edit file** from the three dotted **...** menu in the upper right corner of the file view on `index.md`. |
| 47 | +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**. |
| 48 | +1. Above your new content, click **Preview**. |
| 49 | +1. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. |
| 50 | +1. Click **Commit changes**. |
| 51 | +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. |
0 commit comments