From 79e2df20b010d9247a679b61c6bcc4e99a8e05f9 Mon Sep 17 00:00:00 2001 From: Qiming Teng Date: Mon, 26 Oct 2020 16:50:29 +0800 Subject: [PATCH] Fix smoke test doc --- content/en/docs/test.md | 52 ++++++++++++++++----------------------- static/images/pencil.png | Bin 700 -> 1405 bytes 2 files changed, 21 insertions(+), 31 deletions(-) diff --git a/content/en/docs/test.md b/content/en/docs/test.md index 071a873b37..c052cb5f9c 100644 --- a/content/en/docs/test.md +++ b/content/en/docs/test.md @@ -61,9 +61,7 @@ Markdown doesn't have strict rules about how to process lists. When we moved from Jekyll to Hugo, we broke some lists. To fix them, keep the following in mind: -- Make sure you indent sub-list items **4 spaces** rather than the 2 that you - may be used to. Counter-intuitively, you need to indent block-level content - within a list item an extra 4 spaces too. +- Make sure you indent sub-list items **2 spaces**. - To end a list and start another, you need a HTML comment block on a new line between the lists, flush with the left-hand border. The first list won't end @@ -74,10 +72,9 @@ mind: - This is a list item * This is another list item in the same list - You can mix `-` and `*` - - To make a sub-item, indent two tabstops (4 spaces). **This is different - from Jekyll and Kramdown.** - - This is a sub-sub-item. Indent two more tabstops (4 more spaces). - - Another sub-item. + - To make a sub-item, indent two spaces. + - This is a sub-sub-item. Indent two more spaces. + - Another sub-item. @@ -85,15 +82,15 @@ mind: consecutive lists. **The HTML comment needs to be at the left margin.** - Bullet lists can have paragraphs or block elements within them. - Indent the content to be one tab stop beyond the text of the bullet - point. **This paragraph and the code block line up with the second `l` in - `Bullet` above.** + Indent the content to be the same as the first line of the bullet point. + **This paragraph and the code block line up with the first `B` in `Bullet` + above.** - ```bash - ls -l - ``` + ```bash + ls -l + ``` - - And a sub-list after some block-level content + - And a sub-list after some block-level content - A bullet list item can contain a numbered list. 1. Numbered sub-list item 1 @@ -116,13 +113,13 @@ mind: two consecutive lists. **The HTML comment needs to be at the left margin.** 2. Numbered lists can have paragraphs or block elements within them. - Just indent the content to be one tab stop beyond the text of the bullet - point. **This paragraph and the code block line up with the `m` in - `Numbered` above.** + Just indent the content to be the same as the first line of the bullet + point. **This paragraph and the code block line up with the `N` in + `Numbered` above.** - ```bash - ls -l - ``` + ```bash + ls -l + ``` - And a sub-list after some block-level content. This is at the same "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 language of the enclosed code, which enables syntax highlighting. It is also more predictable than using indentation. -{{< warning >}} -There is one situation where you need to use indentation for code blocks: when -the contents of the code block contain lines starting with `-` or `*` characters. -This is due to -[blackfriday issue #239](https://github.com/russross/blackfriday/issues/239). -{{< /warning >}} - ``` this is a code block created by back-ticks ``` @@ -241,7 +231,7 @@ character. The square brackets contain the image's alt text. Try to always use alt text so that people using screen readers can get some benefit from the image. -![pencil icon](/static/images/pencil.png) +![pencil icon](/images/pencil.png) To specify extended attributes, such as width, title, caption, etc, use the figure shortcode, @@ -249,17 +239,17 @@ which is preferred to using a HTML `` tag. Also, if you need the image to also be a hyperlink, use the `link` attribute, rather than wrapping the whole figure in Markdown link syntax as shown below. -{{< figure src="/static/images/pencil.png" title="Pencil icon" caption="Image used to illustrate the figure shortcode" width="200px" >}} +{{< figure src="/images/pencil.png" title="Pencil icon" caption="Image used to illustrate the figure shortcode" width="200px" >}} Even if you choose not to use the figure shortcode, an image can also be a link. This time the pencil icon links to the Kubernetes website. Outer square brackets enclose the entire image tag, and the link target is in the parentheses at the end. -[![pencil icon](/static/images/pencil.png)](https://kubernetes.io) +[![pencil icon](/images/pencil.png)](https://kubernetes.io) You can also use HTML for images, but it is not preferred. -pencil icon +pencil icon ## Tables diff --git a/static/images/pencil.png b/static/images/pencil.png index 300600da05e637df0b8bcf0743e941eb6e6c27a8..4f0000f639f6772550c2b39e563a3dddcc8a917b 100644 GIT binary patch literal 1405 zcmeAS@N?(olHy`uVBq!ia0vp^Mj*_=1|;R|J2nC-#^NA%Cx&(BWL^R}0jUw5X}-P; zT0k}j0~4bV12aeo5Hhr9GO&Qz3=C>Ont_3N0V6_o0TW!-XaO^V4N{mc*0>dDNMvS6 zL`j6Nk5zJhu3lnFep0GlMQ#B|0fSA26_A;mT9T+xk(-lOY*k^a1Xf`MWP^nDl@!2A zO0sR0B76fBob!uP6-@O^^bC~jxD*r=Y>HCStb$zJpxS{vTcwPWk^(Dz{qpj1y>er{ z{GxPyLrY6beFGzXBO_g)3f4M^0=zbG>mXfw!sJ3||=N)$1u zJvRCv%aI%d@hMmo=v6x|8+~}N*>U+CQjY}2NtvgMV@L+;+i9LY!hsSE)|dUVziXyy zcDM*=Mmst-ol@E~#iONLU06ui*(t@+_{t2=**;T-e0K#gTE- zFn0;7cC_Nstv=H~`ucE8C|F<|te?*}`Fh&D|Nq|q{{KDALZ-rz`2vFp1Fr*u`pwoP zr1k05(pLti!rp~5IUYIlEL|35-LT+AWo1Y}=iPk^i*;|-{}xEk=GtZY>AnN!G^aa$ z*VkNs`>kI`I_Kd}=7d_x=KW{ONSz4^hhdv)l<7{)Rl*T9%HhnmIN zdCu-T^h21%f6bZykG@V&$XAJ+C@|0R_Kj*r2i4-AdnR06`O|22;>kza9FJZfsXZ4Q zB%t^E+4G+VZ(i#-^Fxef&6~pNUCX3)>3=@F#3|{Z+1B$jtmVERmkVs{wS8PBuy@(J zjmw-R3wdALPtV$umv65o@}wyz!#Thur}>2N>aB{)pJ2Un+!77=l~jdo5rEylunB*fL}VD+Nx%g?Svvhm6a-YoRL);n#rgdX3NmJ`{_ zqkmoIIDPC#S+h_7%oQFBmTg*a{`Dt|=OxMc{Bt{N^M0qUeSGqW1uNq>7rom8Q$*x^ zjhzhQpM9+2(I{0x0*Gq&z1j*Gyb+<4@)z z8EN-7-?-k$U0%h}q~P^xhrkKf@JFZ5AM>%f5F4_jO_`x-qxrXYE#H5=HTF2ObdAjh z{WTn(e3MnuB^?5nU+Vd~dghI6L$m+iC0!c2{U^$O-|_F>@1O|}>OJTA8XB0PrgtE3 bL*4`ZiyC&$nJNmPB9y_?)z4*}Q$iB}B!?={ literal 700 zcmeAS@N?(olHy`uVBq!ia0vp^Mj*_=3?wxlRx~p(FzN*Ogt!8^|3?9FA>be8r~(YH zVvt^+k3*kbJp&!CHa4PuIOQyt5=^ue^rDLf;RC$M~PE@+>WTWG?mC z>vzUCU7j~93#xueFU$R6A@pvA_xJ2d*RM9$rv;>G-#_p7ms9CxN=flX-WxA2|J$SE ze729Rrhf9)9Cn~}cRXDjLnI{M9(--Z6ez;>KwoXH&%$NRPFHTYq?IgFaama8v2;q( z-T$^Ftn<>}-v9R7Dexcj@l#q)GW?>79owFL6R3=R@Oka)55lYmwr$+$YSpC391~?B zq}r8x{NPlMw{PC5e%It%*Bo+diF08I&$=_6|4pjZbfjaR@7yy}SHzob$Ek;1p5l)- zajm-*`gd1harCBxODmPjLj=xN7yOiqdiyN-VinW$-#ahATD`6T;hYJh0-H