|
2 | 2 |
|
3 | 3 | ## Table of contents <!-- omit in toc -->
|
4 | 4 | - [Writing in Markdown](#writing-in-markdown)
|
5 |
| -- [Callout tags](#callout-tags) |
| 5 | +- [Lists](#lists) |
6 | 6 | - [Usage](#usage)
|
7 |
| -- [Code sample syntax highlighting](#code-sample-syntax-highlighting) |
| 7 | +- [Callout tags](#callout-tags) |
8 | 8 | - [Usage](#usage-1)
|
9 |
| -- [Octicons](#octicons) |
| 9 | +- [Code sample syntax highlighting](#code-sample-syntax-highlighting) |
10 | 10 | - [Usage](#usage-2)
|
11 |
| -- [Operating system tags](#operating-system-tags) |
| 11 | +- [Octicons](#octicons) |
12 | 12 | - [Usage](#usage-3)
|
13 |
| -- [Tool tags](#tool-tags) |
| 13 | +- [Operating system tags](#operating-system-tags) |
14 | 14 | - [Usage](#usage-4)
|
| 15 | +- [Tool tags](#tool-tags) |
| 16 | + - [Usage](#usage-5) |
15 | 17 | - [Reusable and variable strings of text](#reusable-and-variable-strings-of-text)
|
16 | 18 |
|
17 | 19 | ## Writing in Markdown
|
18 | 20 |
|
19 |
| -[Markdown](http://daringfireball.net/projects/markdown/) is a human-friendly syntax for formatting plain text. Our documentation is written with [GitHub Flavored Markdown](https://docs.github.com/en/github/writing-on-github/about-writing-and-formatting-on-github), a custom version of Markdown used across GitHub. |
| 21 | +[Markdown](http://daringfireball.net/projects/markdown/) is a human-friendly syntax for formatting plain text. Our documentation is written with [GitHub Flavored Markdown](https://docs.github.com/en/github/writing-on-github/about-writing-and-formatting-on-github), a custom version of Markdown based on the [CommonMark specification](https://github.github.com/gfm/), and it is used across GitHub. |
20 | 22 |
|
21 | 23 | This site's Markdown rendering is powered by [`/lib/render-content`](/lib/render-content), which is in turn built on the [`remark`](https://remark.js.org/) Markdown processor.
|
22 | 24 |
|
| 25 | +## Lists |
| 26 | + |
| 27 | +In a list item, the general rules for additional content after the first paragraph are: |
| 28 | + |
| 29 | +* Images and subsequent paragraphs should each **be on their own line and separated by a blank line**. |
| 30 | +* All subsequent lines in a list item **must match up with the first text after the list marker**. |
| 31 | + |
| 32 | +### Usage |
| 33 | + |
| 34 | +For example, this is the correct way to write list items with multiple paragraphs or objects: |
| 35 | + |
| 36 | +```markdown |
| 37 | +1. Under your repository name, click **Actions**. |
| 38 | + |
| 39 | +  |
| 40 | + |
| 41 | + This is another paragraph in the list. |
| 42 | +1. This is the next item. |
| 43 | +``` |
| 44 | + |
| 45 | + |
| 46 | + |
23 | 47 | ## Callout tags
|
24 | 48 |
|
25 | 49 | Callouts highlight important information that customers need to know. We use standard formatting and colors for different types of callouts: notes, warnings, and danger notices. Use tags before and after the text you’d like included in the callout box.
|
|
0 commit comments