Fix markdown escaping (#19744)

Signed-off-by: Celeste Horgan <celeste@cncf.io>
This commit is contained in:
Celeste Horgan
2020-03-23 13:22:45 +01:00
committed by GitHub
parent 1c263b2314
commit fbaeb89823
+14 -14
View File
@@ -102,7 +102,7 @@ Do | Don't
:--| :----- :--| :-----
Open the `envars.yaml` file. | Open the envars.yaml file. Open the `envars.yaml` file. | Open the envars.yaml file.
Go to the `/docs/tutorials` directory. | Go to the /docs/tutorials directory. Go to the `/docs/tutorials` directory. | Go to the /docs/tutorials directory.
Open the `/_data/concepts.yaml` file. | Open the /_data/concepts.yaml file. Open the `/_data/concepts.yaml` file. | Open the /\_data/concepts.yaml file.
{{< /table >}} {{< /table >}}
### Use the international standard for punctuation inside quotes ### Use the international standard for punctuation inside quotes
@@ -119,15 +119,15 @@ The copy is called a "fork". | The copy is called a "fork."
### Use code style for inline code and commands ### Use code style for inline code and commands
For inline code in an HTML document, use the `<code>` tag. In a Markdown For inline code in an HTML document, use the `<code>` tag. In a Markdown
document, use the backtick (`). document, use the backtick (`` ` ``).
{{< table caption = "Do and Don't - Use code style for inline code and commands" >}} {{< table caption = "Do and Don't - Use code style for inline code and commands" >}}
Do | Don't Do | Don't
:--| :----- :--| :-----
The `kubectl run`command creates a Deployment. | The "kubectl run" command creates a Deployment. The `kubectl run`command creates a Deployment. | The "kubectl run" command creates a Deployment.
For declarative management, use `kubectl apply`. | For declarative management, use "kubectl apply". For declarative management, use `kubectl apply`. | For declarative management, use "kubectl apply".
Enclose code samples with triple backticks. `(```)`| Enclose code samples with any other syntax. Enclose code samples with triple backticks. (\`\`\`)| Enclose code samples with any other syntax.
Use single backticks to enclose inline code. For example, `var example = true`. | Use two asterisks (**) or an underscore (_) to enclose inline code. For example, **var example = true**. Use single backticks to enclose inline code. For example, `var example = true`. | Use two asterisks (`**`) or an underscore (`_`) to enclose inline code. For example, **var example = true**.
Use triple backticks before and after a multi-line block of code for fenced code blocks. | Use multi-line blocks of code to create diagrams, flowcharts, or other illustrations. Use triple backticks before and after a multi-line block of code for fenced code blocks. | Use multi-line blocks of code to create diagrams, flowcharts, or other illustrations.
Use meaningful variable names that have a context. | Use variable names such as 'foo','bar', and 'baz' that are not meaningful and lack context. Use meaningful variable names that have a context. | Use variable names such as 'foo','bar', and 'baz' that are not meaningful and lack context.
Remove trailing spaces in the code. | Add trailing spaces in the code, where these are important, because the screen reader will read out the spaces as well. Remove trailing spaces in the code. | Add trailing spaces in the code, where these are important, because the screen reader will read out the spaces as well.
@@ -255,7 +255,7 @@ On-premises | On-premises or On-prem rather than On-premise or other variations.
## Shortcodes ## Shortcodes
Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create different rhetorical appeal levels. Our documentation supports three different shortcodes in this category: **Note** {{</* note */>}}, **Caution** {{</* caution */>}}, and **Warning** {{</* warning */>}}. Hugo [Shortcodes](https://gohugo.io/content-management/shortcodes) help create different rhetorical appeal levels. Our documentation supports three different shortcodes in this category: **Note** `{{</* note */>}}`, **Caution** `{{</* caution */>}}`, and **Warning** `{{</* warning */>}}`.
1. Surround the text with an opening and closing shortcode. 1. Surround the text with an opening and closing shortcode.
@@ -275,7 +275,7 @@ The prefix you choose is the same text for the tag.
### Note ### Note
Use {{</* note */>}} to highlight a tip or a piece of information that may be helpful to know. Use `{{</* note */>}}` to highlight a tip or a piece of information that may be helpful to know.
For example: For example:
@@ -291,7 +291,7 @@ The output is:
You can _still_ use Markdown inside these callouts. You can _still_ use Markdown inside these callouts.
{{< /note >}} {{< /note >}}
You can use a {{</* note */>}} in a list: You can use a `{{</* note */>}}` in a list:
``` ```
1. Use the note shortcode in a list 1. Use the note shortcode in a list
@@ -323,7 +323,7 @@ The output is:
### Caution ### Caution
Use {{</* caution */>}} to call attention to an important piece of information to avoid pitfalls. Use `{{</* caution */>}}` to call attention to an important piece of information to avoid pitfalls.
For example: For example:
@@ -341,7 +341,7 @@ The callout style only applies to the line directly above the tag.
### Warning ### Warning
Use {{</* warning */>}} to indicate danger or a piece of information that is crucial to follow. Use `{{</* warning */>}}` to indicate danger or a piece of information that is crucial to follow.
For example: For example:
@@ -391,7 +391,7 @@ For example:
1. Preheat oven to 350˚F 1. Preheat oven to 350˚F
1. Prepare the batter, and pour into springform pan. 1. Prepare the batter, and pour into springform pan.
{{</* note */>}}Grease the pan for best results.{{</* /note */>}} `{{</* note */>}}Grease the pan for best results.{{</* /note */>}}`
1. Bake for 20-25 minutes or until set. 1. Bake for 20-25 minutes or until set.
@@ -429,7 +429,7 @@ Do | Don't
:--| :----- :--| :-----
Update the title in the front matter of the page or blog post. | Use first level heading, as Hugo automatically converts the title in the front matter of the page into a first-level heading. Update the title in the front matter of the page or blog post. | Use first level heading, as Hugo automatically converts the title in the front matter of the page into a first-level heading.
Use ordered headings to provide a meaningful high-level outline of your content. | Use headings level 4 through 6, unless it is absolutely necessary. If your content is that detailed, it may need to be broken into separate articles. Use ordered headings to provide a meaningful high-level outline of your content. | Use headings level 4 through 6, unless it is absolutely necessary. If your content is that detailed, it may need to be broken into separate articles.
Use pound or hash signs (#) for non-blog post content. | Use underlines (--- or ===) to designate first-level headings. Use pound or hash signs (`#`) for non-blog post content. | Use underlines (`---` or `===`) to designate first-level headings.
Use sentence case for headings. For example, **Extend kubectl with plugins** | Use title case for headings. For example, **Extend Kubectl With Plugins** Use sentence case for headings. For example, **Extend kubectl with plugins** | Use title case for headings. For example, **Extend Kubectl With Plugins**
{{< /table >}} {{< /table >}}
@@ -439,7 +439,7 @@ Use sentence case for headings. For example, **Extend kubectl with plugins** | U
Do | Don't Do | Don't
:--| :----- :--| :-----
Try to keep paragraphs under 6 sentences. | Indent the first paragraph with space characters. For example, ⋅⋅⋅Three spaces before a paragraph will indent it. Try to keep paragraphs under 6 sentences. | Indent the first paragraph with space characters. For example, ⋅⋅⋅Three spaces before a paragraph will indent it.
Use three hyphens (---) to create a horizontal rule. Use horizontal rules for breaks in paragraph content. For example, a change of scene in a story, or a shift of topic within a section. | Use horizontal rules for decoration. Use three hyphens (`---`) to create a horizontal rule. Use horizontal rules for breaks in paragraph content. For example, a change of scene in a story, or a shift of topic within a section. | Use horizontal rules for decoration.
{{< /table >}} {{< /table >}}
### Links ### Links
@@ -460,9 +460,9 @@ Website navigation links can also be marked up as list items; after all they are
{{< note >}} Ordered lists that are part of an incomplete introductory sentence can be in lowercase and punctuated as if each item was a part of the introductory sentence.{{< /note >}} {{< note >}} Ordered lists that are part of an incomplete introductory sentence can be in lowercase and punctuated as if each item was a part of the introductory sentence.{{< /note >}}
- Use the number one (1.) for ordered lists. - Use the number one (`1.`) for ordered lists.
- Use (+), (* ), or (-) for unordered lists. - Use (`+`), (`*`), or (`-`) for unordered lists.
- Leave a blank line after each list. - Leave a blank line after each list.