Skip to content

Commit 1f43363

Browse files
authored
Merge pull request #24720 from tengqm/fix-smoke-test
Fix smoke test doc
2 parents ee9e7e2 + 79e2df2 commit 1f43363

File tree

2 files changed

+21
-31
lines changed

2 files changed

+21
-31
lines changed

content/en/docs/test.md

Lines changed: 21 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,7 @@ 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 **4 spaces** rather than the 2 that you
65-
may be used to. Counter-intuitively, you need to indent block-level content
66-
within a list item an extra 4 spaces too.
64+
- Make sure you indent sub-list items **2 spaces**.
6765

6866
- To end a list and start another, you need a HTML comment block on a new line
6967
between the lists, flush with the left-hand border. The first list won't end
@@ -74,26 +72,25 @@ mind:
7472
- This is a list item
7573
* This is another list item in the same list
7674
- You can mix `-` and `*`
77-
- To make a sub-item, indent two tabstops (4 spaces). **This is different
78-
from Jekyll and Kramdown.**
79-
- This is a sub-sub-item. Indent two more tabstops (4 more spaces).
80-
- Another sub-item.
75+
- To make a sub-item, indent two spaces.
76+
- This is a sub-sub-item. Indent two more spaces.
77+
- Another sub-item.
8178

8279
<!-- separate lists -->
8380

8481
- This is a new list. With Hugo, you need to use a HTML comment to separate two
8582
consecutive lists. **The HTML comment needs to be at the left margin.**
8683
- Bullet lists can have paragraphs or block elements within them.
8784

88-
Indent the content to be one tab stop beyond the text of the bullet
89-
point. **This paragraph and the code block line up with the second `l` in
90-
`Bullet` above.**
85+
Indent the content to be the same as the first line of the bullet point.
86+
**This paragraph and the code block line up with the first `B` in `Bullet`
87+
above.**
9188

92-
```bash
93-
ls -l
94-
```
89+
```bash
90+
ls -l
91+
```
9592

96-
- And a sub-list after some block-level content
93+
- And a sub-list after some block-level content
9794

9895
- A bullet list item can contain a numbered list.
9996
1. Numbered sub-list item 1
@@ -116,13 +113,13 @@ mind:
116113
two consecutive lists. **The HTML comment needs to be at the left margin.**
117114
2. Numbered lists can have paragraphs or block elements within them.
118115

119-
Just indent the content to be one tab stop beyond the text of the bullet
120-
point. **This paragraph and the code block line up with the `m` in
121-
`Numbered` above.**
116+
Just 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.**
122119

123-
```bash
124-
ls -l
125-
```
120+
```bash
121+
ls -l
122+
```
126123

127124
- And a sub-list after some block-level content. This is at the same
128125
"level" as the paragraph and code block above, despite being indented
@@ -178,13 +175,6 @@ back-ticks (code fences) for code blocks.** This allows you to specify the
178175
language of the enclosed code, which enables syntax highlighting. It is also more
179176
predictable than using indentation.
180177

181-
{{< warning >}}
182-
There is one situation where you need to use indentation for code blocks: when
183-
the contents of the code block contain lines starting with `-` or `*` characters.
184-
This is due to
185-
[blackfriday issue #239](https://github.com/russross/blackfriday/issues/239).
186-
{{< /warning >}}
187-
188178
```
189179
this is a code block created by back-ticks
190180
```
@@ -241,25 +231,25 @@ character. The square brackets contain the image's alt text. Try to always use
241231
alt text so that people using screen readers can get some benefit from the
242232
image.
243233
244-
![pencil icon](/static/images/pencil.png)
234+
![pencil icon](/images/pencil.png)
245235
246236
To specify extended attributes, such as width, title, caption, etc, use the
247237
<a href="https://gohugo.io/content-management/shortcodes/#figure">figure shortcode</a>,
248238
which is preferred to using a HTML `<img>` tag. Also, if you need the image to
249239
also be a hyperlink, use the `link` attribute, rather than wrapping the whole
250240
figure in Markdown link syntax as shown below.
251241
252-
{{< figure src="/static/images/pencil.png" title="Pencil icon" caption="Image used to illustrate the figure shortcode" width="200px" >}}
242+
{{< figure src="/images/pencil.png" title="Pencil icon" caption="Image used to illustrate the figure shortcode" width="200px" >}}
253243
254244
Even if you choose not to use the figure shortcode, an image can also be a link. This
255245
time the pencil icon links to the Kubernetes website. Outer square brackets enclose
256246
the entire image tag, and the link target is in the parentheses at the end.
257247
258-
[![pencil icon](/static/images/pencil.png)](https://kubernetes.io)
248+
[![pencil icon](/images/pencil.png)](https://kubernetes.io)
259249
260250
You can also use HTML for images, but it is not preferred.
261251
262-
<img src="/static/images/pencil.png" alt="pencil icon" />
252+
<img src="/images/pencil.png" alt="pencil icon" />
263253
264254
265255
## Tables

static/images/pencil.png

705 Bytes
Loading

0 commit comments

Comments
 (0)