Skip to content

Commit 5aa0772

Browse files
authored
Merge pull request #21 from xebia/1.3-GitHub-Markdown
1.3-GitHub-Markdown
2 parents c50a271 + 9524984 commit 5aa0772

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

learn-pr/github/communicate-using-markdown/includes/2-what-is-markdown.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff 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.
22

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.
44

55
> [!NOTE]
66
> 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
99

1010
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?
1111

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:
1313

1414
```markdown
1515
This is *italic* text.
@@ -39,7 +39,7 @@ __This is bold and *italic* text__ using double underscores for bold and single
3939
>_This is **italic and bold** text_ using a single underscore for italic and double asterisks for bold.
4040
> __This is bold and *italic* text__ using double underscores for bold and single asterisks for italic.
4141
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.
4343

4444
```markdown
4545
\_This is all \*\*plain\*\* text\_.
@@ -59,7 +59,7 @@ HTML provides content headings such as the `<h1>` tag. In Markdown, this is supp
5959
6060
## Link to images and sites
6161

62-
Image and site links use a similar syntax.
62+
Image and site links follow a similar structure.
6363

6464
```markdown
6565
![Link an image.](/learn/azure-devops/shared/media/mara.png)
@@ -75,7 +75,7 @@ Image and site links use a similar syntax.
7575
7676
## Make lists
7777

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.
7979

8080
* Ordered lists start with numbers.
8181
* Unordered lists can use asterisks or dashes (`-`).
@@ -146,7 +146,7 @@ Here is a<br />line break
146146
147147
## Work with code
148148

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.
150150

151151
```markdown
152152
This is `code`.
@@ -209,7 +209,7 @@ You can link to a commit by either pasting in its ID or simply using its secure
209209
210210
## Mention users and teams
211211
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.
213213
214214
```markdown
215215
@githubteacher
@@ -231,9 +231,9 @@ You can create task lists within issues or pull requests using the following syn
231231

232232
## Slash commands
233233

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.
235235

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.
237237

238238
| Command | Description |
239239
| -------------- | ------------- |

0 commit comments

Comments
 (0)