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
Copy file name to clipboardExpand all lines: learn-pr/github/communicate-using-markdown/includes/2-what-is-markdown.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
Markdown is a markup language that offers a lean approach to content editing by shielding content creators from the overhead of HTML. While HTML is great for rendering content exactly how it was intended, it takes up a lot of space and can be unwieldy to work with, even in small doses. Markdown offers a great compromise between the power of HTML for content description and the ease of plain text for editing.
1
+
Markdown is a markup language that offers a lean approach to content editing by shielding content creators from the overhead of HTML. While HTML is great for rendering content exactly how it was intended, it takes up a lot of space and can be unwieldy to work with, even in small doses. Markdown offers an effective compromise between the power of HTML for content description and the ease of plain text for editing.
2
2
3
-
In this unit, we'll discuss Markdown's structure and syntax. We'll also cover features of GitHub-Flavored Markdown (GFM), which are syntax extensions that allow you to integrate GitHub features into content.
3
+
In this unit, we'll discuss Markdown's structure and syntax. We'll also cover features of GitHub-Flavored Markdown (GFM), including extensions for integrating GitHub features into your content.
4
4
5
5
> [!NOTE]
6
6
> This unit is intended to give you a taste of what Markdown is about. For a more in-depth review, reference the **Markdown syntax description** and **GitHub-Flavored Markdown Spec** articles in this module's Summary unit.
@@ -9,7 +9,7 @@ In this unit, we'll discuss Markdown's structure and syntax. We'll also cover fe
9
9
10
10
The most important part of any communication on GitHub is usually the text itself, but how do you show that some parts of the text are more important than others?
11
11
12
-
Using italics in text is as easy as surrounding the target text with single asterisks (`*`) or single underscores (`_`). Just be sure to close an emphasis with the same character with which you opened it. Be observant of how you combine the use of asterisks and underscores. Here are several examples:
12
+
Using italics in text is as easy as surrounding the target text with single asterisks (`*`) or single underscores (`_`). Just be sure to close an emphasis with the same character you used to open it. Pay attention to consistency when combining asterisks and underscores. Here are several examples:
13
13
14
14
```markdown
15
15
This is *italic* text.
@@ -39,7 +39,7 @@ __This is bold and *italic* text__ using double underscores for bold and single
39
39
>_This is **italic and bold** text_ using a single underscore for italic and double asterisks for bold.
40
40
> __This is bold and *italic* text__ using double underscores for bold and single asterisks for italic.
41
41
42
-
To use a literal asterisk, precede it with an escape character; in GFM, that's a backslash (`\`). This example results in the underscores and asterisks being shown in the output.
42
+
To use a literal asterisk, precede it with an escape character; in GFM, that's a backslash (`\`). This displays the underscores and asterisks as plain text.
43
43
44
44
```markdown
45
45
\_This is all \*\*plain\*\* text\_.
@@ -59,7 +59,7 @@ HTML provides content headings such as the `<h1>` tag. In Markdown, this is supp
59
59
60
60
## Link to images and sites
61
61
62
-
Image and site links use a similar syntax.
62
+
Image and site links follow a similar structure.
63
63
64
64
```markdown
65
65

@@ -75,7 +75,7 @@ Image and site links use a similar syntax.
75
75
76
76
## Make lists
77
77
78
-
You can define ordered or unordered lists. You can also define nested items through indentation.
78
+
You can define ordered or unordered lists. You can also create nested items through indentation.
79
79
80
80
* Ordered lists start with numbers.
81
81
* Unordered lists can use asterisks or dashes (`-`).
@@ -146,7 +146,7 @@ Here is a<br />line break
146
146
147
147
## Work with code
148
148
149
-
Markdown provides default behavior for working with inline code blocks delimited by the backtick (\`) character. When decorating text with this character, it's rendered as code.
149
+
Markdown provides default behavior for working with inline code blocks delimited by the backtick (\`) character. Wrapping text in backticks renders it as code.
150
150
151
151
```markdown
152
152
This is `code`.
@@ -209,7 +209,7 @@ You can link to a commit by either pasting in its ID or simply using its secure
209
209
210
210
## Mention users and teams
211
211
212
-
Typing an `@` symbol followed by a GitHub username sends a notification to that person about the comment. This is called an "@mention", because you're mentioning the individual. You can also `@mention` teams within an organization.
212
+
Typing an `@` symbol followed by a GitHub username sends a notification to that person about the comment. This is called an "@mention", and highlights the user or team.
213
213
214
214
```markdown
215
215
@githubteacher
@@ -231,9 +231,9 @@ You can create task lists within issues or pull requests using the following syn
231
231
232
232
## Slash commands
233
233
234
-
Slash commands can save you time by reducing the typing required to create complex Markdown.
234
+
Slash commands can save you time by reducing the typing required to create structured content.
235
235
236
-
You can use slash commands in any description or comment field in issues, pull requests, or discussions where that slash command is supported.
236
+
You can use slash commands in any description or comment field in issues, pull requests, or discussions where supported.
0 commit comments