Kubernetes Documentation Style Guide and Smoke Test

--- title: Docs smoke test page main_menu: false --- This page serves two purposes: - Demonstrate how the Kubernetes documentation uses Markdown - Provide a "smoke test" document we can use to test HTML, CSS, and template changes that affect the overall documentation. ## Heading levels The above heading is an H2. The page title renders as an H1. The following sections show H3 - H6. ```markdown ### H3 This is in an H3 section. #### H4 This is in an H4 section. ##### H5 This is in an H5 section. ###### H6 This is in an H6 section. ``` Produces: ### H3 This is in an H3 section. #### H4 This is in an H4 section. ##### H5 This is in an H5 section. ###### H6 This is in an H6 section. ## Inline elements Inline elements show up within the text of paragraph, list item, admonition, or other block-level element. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. ### Inline text styles You can use different text styles in markdown like: ```markdown - **bold** - _italic_ - ***bold italic*** - ~~strikethrough~~ - underline - _underline italic_ - **underline bold** - ***underline bold italic*** - `monospace text` - **`monospace bold`** ``` Produces: - **bold** - _italic_ - ***bold italic*** - ~~strikethrough~~ - underline - _underline italic_ - **underline bold** - ***underline bold italic*** - `monospace text` - **`monospace bold`** ## Lists 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 **2 spaces**. - To end a list and start another, you need an HTML comment block on a new line between the lists, flush with the left-hand border. The first list won't end otherwise, no matter how many blank lines you put between it and the second. ### Bullet lists You can add a bullet list in markdown like: ```markdown - 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 spaces. - This is a sub-sub-item. Indent two more spaces. - Another sub-item. ``` Produces: - 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 spaces. - This is a sub-sub-item. Indent two more spaces. - Another sub-item. Also, - This is a new list. With Hugo, you need to use a HTML comment to separate two 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 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 ``` - And a sub-list after some block-level content - A bullet list item can contain a numbered list. 1. Numbered sub-list item 1 1. Numbered sub-list item 2 ### Numbered lists 1. This is a list item. 1. This is another list item in the same list. The number you use in Markdown does not necessarily correlate to the number in the final output. By convention, we keep them in sync. {{<note>}} For single-digit numbered lists, using two spaces after the period makes interior block-level content line up better along tab-stops. {{</note>}}  1. This is a new list. With Hugo, you need to use an HTML comment to separate two consecutive lists. **The HTML comment needs to be at the left margin.** 1. Numbered lists can have paragraphs or block elements within them.

This document serves as both a demonstration of Markdown usage in Kubernetes documentation and a 'smoke test' for HTML, CSS, and template changes. It covers various aspects of Markdown, including heading levels (H2-H6), inline elements and text styles (bold, italic, strikethrough, underline, monospace), and lists (bulleted and numbered). The document emphasizes the importance of proper indentation and the use of HTML comments to separate consecutive lists to ensure correct rendering with Hugo.