Skip to content

Commit 8d504e3

Browse files
authored
chore: Revert updates to honor maintenance mode (#287)
1 parent 8e39a0a commit 8d504e3

24 files changed

+652
-992
lines changed

.github/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "monthly"

.github/steps/-step.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0

.github/steps/0-welcome.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<!-- readme -->

.github/steps/1-add-headers.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
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.

.github/steps/1-add-headings.md

Lines changed: 0 additions & 73 deletions
This file was deleted.

.github/steps/2-add-an-image.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!--
2+
<<< Author notes: Step 2 >>>
3+
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+
![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)
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.

.github/steps/2-make-a-task-list.md

Lines changed: 0 additions & 77 deletions
This file was deleted.
Lines changed: 31 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,49 @@
1-
## Step 3: Add a code sample
1+
<!--
2+
<<< Author notes: Step 3 >>>
3+
Start this step by acknowledging the previous step.
4+
Define terms and link to docs.github.com.
5+
-->
26

3-
Let's learn about [code blocks](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code) and [syntax highlighting](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) based on the language.
7+
## Step 3: Add a code example
48

5-
> [!TIP]
6-
> Many programming languages are supported. Try testing out some other file extension types!
9+
_Great job adding an image to the file :tada:_
710

8-
### Example: Terminal Command
11+
Let's add some code blocks. Code blocks can render differently depending on the language.
912

10-
````md
11-
```bash
12-
git clone https://github.com/skills/communicate-using-markdown
13+
### Example 1
14+
15+
<pre>
16+
```
17+
$ git init
18+
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
1319
```
14-
````
20+
</pre>
1521

16-
```bash
17-
git clone https://github.com/skills/communicate-using-markdown
22+
#### How it looks
23+
24+
```
25+
$ git init
26+
Initialized empty Git repository in /Users/skills/Projects/recipe-repository/.git/
1827
```
1928

20-
### Example: Javascript Code
29+
### Example 2
2130

22-
````md
23-
```js
31+
<pre>
32+
``` javascript
2433
var myVar = "Hello, world!";
2534
```
26-
````
35+
</pre>
2736

28-
```js
37+
#### How it looks
38+
39+
```javascript
2940
var myVar = "Hello, world!";
3041
```
3142

3243
### :keyboard: Activity: Adding a code example
3344

34-
1. On the `start-blog` branch, open the `day-1.md` file for editing.
35-
36-
1. Below **Review** level two heading add the following entry recording an awesome code snippet you just learned from the GitHub Blog.
37-
38-
````md
39-
Convert an image or video from dark mode to light mode using [ffmpeg](https://www.ffmpeg.org)
40-
41-
```bash
42-
ffmpeg -i input.mp4 -vf "negate,hue=h=180,eq=contrast=1.2:saturation=1.1" output.mp4
43-
```
44-
````
45-
45+
1. As you did before, edit the file in this pull request.
46+
1. In the file, add the correct Markdown for a code example of your choice.
4647
1. Use the **Preview** tab to check your Markdown formatting.
47-
48-
1. In the top right, click the **Commit changes** button and commit directly to the `start-blog` branch.
49-
50-
1. With our code block committed, Mona should be busy reviewing your work and preparing the next steps.
51-
52-
<details>
53-
<summary>Having trouble? 🤷</summary><br/>
54-
55-
- Confirm you are editing the correct file and branch.
56-
- Double check your syntax. A code block is three backticks ` ``` ` not three apostrophes `'''`
57-
58-
</details>
48+
1. Commit your changes.
49+
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

Comments
 (0)