@@ -61,17 +61,17 @@ Markdown doesn't have strict rules about how to process lists. When we moved
61
61
from Jekyll to Hugo, we broke some lists. To fix them, keep the following in
62
62
mind:
63
63
64
- - Make sure you indent sub-list items ** 2 spaces** .
64
+ - Make sure you indent sub-list items ** 2 spaces** .
65
65
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
67
67
between the lists, flush with the left-hand border. The first list won't end
68
68
otherwise, no matter how many blank lines you put between it and the second.
69
69
70
70
### Bullet lists
71
71
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 ` * ` .
75
75
- To make a sub-item, indent two spaces.
76
76
- This is a sub-sub-item. Indent two more spaces.
77
77
- Another sub-item.
@@ -93,37 +93,38 @@ mind:
93
93
- And a sub-list after some block-level content
94
94
95
95
- 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
98
98
99
99
### Numbered lists
100
100
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 >}}
109
110
110
111
<!-- separate lists -->
111
112
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.
115
116
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.**
119
120
120
- ``` bash
121
- ls -l
122
- ```
121
+ ``` bash
122
+ ls -l
123
+ ```
123
124
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.
127
128
128
129
### Tab lists
129
130
@@ -218,11 +219,13 @@ source for this page).
218
219
## Links
219
220
220
221
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](/) `
223
226
224
227
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> ` .
226
229
227
230
## Images
228
231
@@ -251,7 +254,6 @@ You can also use HTML for images, but it is not preferred.
251
254
252
255
<img src =" /images/pencil.png " alt =" pencil icon " />
253
256
254
-
255
257
## Tables
256
258
257
259
Simple tables have one row per line, and columns are separated by ` | `
@@ -299,7 +301,7 @@ graph TD;
299
301
{{</*/ mermaid */>}}
300
302
```
301
303
302
- Produces:
304
+ Produces:
303
305
304
306
{{< mermaid >}}
305
307
graph TD;
@@ -323,7 +325,7 @@ sequenceDiagram
323
325
{{</*/ mermaid */>}}
324
326
```
325
327
326
- Produces:
328
+ Produces:
327
329
328
330
{{< mermaid >}}
329
331
sequenceDiagram
@@ -337,7 +339,7 @@ sequenceDiagram
337
339
Alice->John: Yes... John, how are you?
338
340
{{</ mermaid >}}
339
341
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.
341
343
342
344
## Sidebars and Admonitions
343
345
@@ -358,7 +360,6 @@ A sidebar offsets text visually, but without the visual prominence of
358
360
> ``` bash
359
361
> sudo dmesg
360
362
> ` ` `
361
- >
362
363
363
364
# ## Admonitions
364
365
@@ -376,13 +377,10 @@ You can have multiple paragraphs and block-level elements inside an admonition.
376
377
The reader should proceed with caution.
377
378
{{< /caution >}}
378
379
379
-
380
380
{{< warning >}}
381
381
Warnings point out something that could cause harm if ignored.
382
382
{{< /warning >}}
383
383
384
-
385
-
386
384
## Includes
387
385
388
386
To add shortcodes to includes.
0 commit comments