You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Start this step by acknowledging the previous step.
4
+
Define terms and link to docs.github.com.
5
+
-->
6
+
7
+
## Step 2: Add an image
8
+
9
+
_Great job adding headers to the file :sparkles:_
10
+
11
+
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:
12
+
13
+
### Example
14
+
15
+
```md
16
+
17
+
```
18
+
19
+
#### How it looks
20
+
21
+
<img alt="Image of Yaktocat" src=https://octodex.github.com/images/yaktocat.png width=400>
22
+
23
+
### :keyboard: Activity: Adding an image
24
+
25
+
1. As you did before, edit the `index.md` file in this pull request.
26
+
1. In the file, add the correct Markdown for your image of choice. Don't forget to include alt-text!
27
+
1. Use the **Preview** tab to check your Markdown formatting.
28
+
1. Commit your changes.
29
+
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.
Start this step by acknowledging the previous step.
4
+
Define terms and link to docs.github.com.
5
+
-->
6
+
7
+
## Step 3: Add a code example
8
+
9
+
_Great job adding an image to the file :tada:_
10
+
11
+
In addition to code blocks, some code blocks should be rendered differently depending on the language, such as JavaScript or command-line text.
12
+
13
+
### Example
14
+
15
+
<pre>
16
+
```
17
+
$ git init
18
+
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
19
+
```
20
+
</pre>
21
+
22
+
#### How it looks
23
+
24
+
```
25
+
$ git init
26
+
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
27
+
```
28
+
29
+
### :keyboard: Activity: Adding a code example
30
+
31
+
1. As you did before, edit the file in this pull request.
32
+
1. In the file, add the correct Markdown for a code example of your choice.
33
+
1. Use the **Preview** tab to check your Markdown formatting.
34
+
1. Commit your changes.
35
+
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.
Start this step by acknowledging the previous step.
4
+
Define terms and link to docs.github.com.
5
+
-->
6
+
7
+
## Step 4: Make a task list
8
+
9
+
_Great job adding a code example to the file :partying_face:_
10
+
11
+
**What is a _task list_?** A task list creates checkboxes to check off. They're very useful for tracking issues and pull requests. If you include a task list in the body of an issue or pull request, you'll see a progress indicator in your issue list. The syntax for task lists is very specific. Be sure to include the spaces where required, or else they won't render.
12
+
13
+
### Example
14
+
15
+
```
16
+
- [x] List syntax is required
17
+
- [x] This item is complete
18
+
- [ ] This item is not complete
19
+
```
20
+
21
+
#### How it looks
22
+
23
+
-[x] List syntax is required
24
+
-[x] This item is complete
25
+
-[ ] This item is not complete
26
+
27
+
### :keyboard: Activity: Add a task list
28
+
29
+
GitHub Actions went ahead and made a branch for you. So you'll need to add to the file we've created in the branch, and we will check your work as you work through this course!
30
+
31
+
1. Return to your pull request.
32
+
1. Use Markdown to create a task list. Here is an example:
33
+
34
+
```md
35
+
-[ ] Turn on GitHub Pages
36
+
-[ ] Outline my portfolio
37
+
-[ ] Introduce myself to the world
38
+
```
39
+
40
+
Remember, a task list starts with the syntax `- [ ]` and then the task list item. The formatting is specific!
41
+
42
+
1. Use the **Preview** tab to check your Markdown formatting.
43
+
1. Commit the changes to the file.
44
+
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.
Start this step by acknowledging the previous step.
4
+
Define terms and link to docs.github.com.
5
+
-->
6
+
7
+
## Step 5: Merge your pull request
8
+
9
+
_Great job adding a task list to the file :heart:_
10
+
11
+
You can now [merge](https://docs.github.com/get-started/quickstart/github-glossary#merge) your pull request!
12
+
13
+
### :keyboard: Activity: Merge your pull request
14
+
15
+
1. Click **Merge pull request**.
16
+
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.
Here's a recap of all the tasks you've accomplished in your repository:
13
+
14
+
1. You learned about Markdown, headings, images, code examples, and task lists.
15
+
1. You created and merged a Markdown file.
16
+
1. You learned an essential GitHub skill. 🎉
17
+
18
+
### What's next?
19
+
20
+
- You can enable GitHub Pages and see your Markdown file as a website!
21
+
1. Under your repository name at the upper right, click :gear:**Settings**.
22
+
1. Then on the lower left, click **Pages** in the **Code and automation** section.
23
+
1. In the **GitHub Pages** section, ensure "Deploy from a branch" is selected from the **Source** drop-down menu, and then select `main` from the **Branch** drop-down menu as your GitHub Pages publishing source.
24
+
1. Click the **Save** button.
25
+
1. Wait about 30 seconds then refresh the page. When you see "Your site is published at ..." you can click on the link to see your published site.
26
+
- Learn more about [Markdown](https://docs.github.com/github/writing-on-github).
27
+
- We'd love to hear what you thought of this course [in our discussion board](https://github.com/skills/.github/discussions)
28
+
-[Take another GitHub Skills course](https://github.com/skills).
29
+
-[Read the GitHub Getting Started docs](https://docs.github.com/get-started).
30
+
- To find projects to contribute to, check out [GitHub Explore](https://github.com/explore).
0 commit comments