Skip to content

Commit 4a0f473

Browse files
committed
polish text and indentations in test.md
1 parent b758a7a commit 4a0f473

File tree

1 file changed

+36
-38
lines changed

1 file changed

+36
-38
lines changed

content/en/docs/test.md

Lines changed: 36 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,17 @@ Markdown doesn't have strict rules about how to process lists. When we moved
6161
from Jekyll to Hugo, we broke some lists. To fix them, keep the following in
6262
mind:
6363

64-
- Make sure you indent sub-list items **2 spaces**.
64+
- Make sure you indent sub-list items **2 spaces**.
6565

66-
- To end a list and start another, you need a HTML comment block on a new line
66+
- To end a list and start another, you need an HTML comment block on a new line
6767
between the lists, flush with the left-hand border. The first list won't end
6868
otherwise, no matter how many blank lines you put between it and the second.
6969

7070
### Bullet lists
7171

72-
- This is a list item
73-
* This is another list item in the same list
74-
- You can mix `-` and `*`
72+
- This is a list item.
73+
* This is another list item in the same list.
74+
- You can mix `-` and `*`.
7575
- To make a sub-item, indent two spaces.
7676
- This is a sub-sub-item. Indent two more spaces.
7777
- Another sub-item.
@@ -93,37 +93,38 @@ mind:
9393
- And a sub-list after some block-level content
9494

9595
- A bullet list item can contain a numbered list.
96-
1. Numbered sub-list item 1
97-
2. Numbered sub-list item 2
96+
1. Numbered sub-list item 1
97+
1. Numbered sub-list item 2
9898

9999
### Numbered lists
100100

101-
1. This is a list item
102-
2. This is another list item in the same list. The number you use in Markdown
103-
does not necessarily correlate to the number in the final output. By
104-
convention, we keep them in sync.
105-
3. {{<note>}}
106-
For single-digit numbered lists, using two spaces after the period makes
107-
interior block-level content line up better along tab-stops.
108-
{{</note>}}
101+
1. This is a list item
102+
1. This is another list item in the same list. The number you use in Markdown
103+
does not necessarily correlate to the number in the final output. By
104+
convention, we keep them in sync.
105+
106+
{{<note>}}
107+
For single-digit numbered lists, using two spaces after the period makes
108+
interior block-level content line up better along tab-stops.
109+
{{</note>}}
109110

110111
<!-- separate lists -->
111112

112-
1. This is a new list. With Hugo, you need to use a HTML comment to separate
113-
two consecutive lists. **The HTML comment needs to be at the left margin.**
114-
2. Numbered lists can have paragraphs or block elements within them.
113+
1. This is a new list. With Hugo, you need to use an HTML comment to separate
114+
two consecutive lists. **The HTML comment needs to be at the left margin.**
115+
1. Numbered lists can have paragraphs or block elements within them.
115116

116-
Indent the content to be the same as the first line of the bullet
117-
point. **This paragraph and the code block line up with the `N` in
118-
`Numbered` above.**
117+
Indent the content to be the same as the first line of the bullet
118+
point. **This paragraph and the code block line up with the `N` in
119+
`Numbered` above.**
119120

120-
```bash
121-
ls -l
122-
```
121+
```bash
122+
ls -l
123+
```
123124

124-
- And a sub-list after some block-level content. This is at the same
125-
"level" as the paragraph and code block above, despite being indented
126-
more.
125+
- And a sub-list after some block-level content. This is at the same
126+
"level" as the paragraph and code block above, despite being indented
127+
more.
127128

128129
### Tab lists
129130

@@ -218,11 +219,13 @@ source for this page).
218219
## Links
219220

220221
To format a link, put the link text inside square brackets, followed by the
221-
link target in parentheses. [Link to Kubernetes.io](https://kubernetes.io/) or
222-
[Relative link to Kubernetes.io](/)
222+
link target in parentheses.
223+
224+
- `[Link to Kubernetes.io](https://kubernetes.io/)` or
225+
- `[Relative link to Kubernetes.io](/)`
223226

224227
You can also use HTML, but it is not preferred.
225-
<a href="https://kubernetes.io/">Link to Kubernetes.io</a>
228+
For example, `<a href="https://kubernetes.io/">Link to Kubernetes.io</a>`.
226229

227230
## Images
228231

@@ -251,7 +254,6 @@ You can also use HTML for images, but it is not preferred.
251254

252255
<img src="/images/pencil.png" alt="pencil icon" />
253256

254-
255257
## Tables
256258

257259
Simple tables have one row per line, and columns are separated by `|`
@@ -299,7 +301,7 @@ graph TD;
299301
{{</*/ mermaid */>}}
300302
```
301303

302-
Produces:
304+
Produces:
303305

304306
{{< mermaid >}}
305307
graph TD;
@@ -323,7 +325,7 @@ sequenceDiagram
323325
{{</*/ mermaid */>}}
324326
```
325327

326-
Produces:
328+
Produces:
327329

328330
{{< mermaid >}}
329331
sequenceDiagram
@@ -337,7 +339,7 @@ sequenceDiagram
337339
Alice->John: Yes... John, how are you?
338340
{{</ mermaid >}}
339341

340-
<br>More [examples](https://mermaid-js.github.io/mermaid/#/examples) from the official docs.
342+
You can check more [examples](https://mermaid-js.github.io/mermaid/#/examples) from the official docs.
341343

342344
## Sidebars and Admonitions
343345

@@ -358,7 +360,6 @@ A sidebar offsets text visually, but without the visual prominence of
358360
> ```bash
359361
> sudo dmesg
360362
> ```
361-
>
362363
363364
### Admonitions
364365
@@ -376,13 +377,10 @@ You can have multiple paragraphs and block-level elements inside an admonition.
376377
The reader should proceed with caution.
377378
{{< /caution >}}
378379
379-
380380
{{< warning >}}
381381
Warnings point out something that could cause harm if ignored.
382382
{{< /warning >}}
383383
384-
385-
386384
## Includes
387385
388386
To add shortcodes to includes.

0 commit comments

Comments
 (0)