Skip to content

Commit 75d48f3

Browse files
authored
Merge pull request #48667 from nate-double-u/48662-update-style-guide-headers-section
Updating Style Guide Headings and Titles section
2 parents 958ed3b + d13d5c5 commit 75d48f3

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

content/en/docs/contribute/style/style-guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,6 +510,8 @@ Use ordered headings to provide a meaningful high-level outline of your content.
510510
Use pound or hash signs (`#`) for non-blog post content. | Use underlines (`---` or `===`) to designate first-level headings.
511511
Use sentence case for headings in the page body. For example, **Extend kubectl with plugins** | Use title case for headings in the page body. For example, **Extend Kubectl With Plugins**
512512
Use title case for the page title in the front matter. For example, `title: Kubernetes API Server Bypass Risks` | Use sentence case for page titles in the front matter. For example, don't use `title: Kubernetes API server bypass risks`
513+
Place relevant links in the body copy. | Include hyperlinks (`<a href=""></a>`) in headings.
514+
Use proper heading markers (`---` or `===`) to indicate headings. | Use **bold** text or other indicators to split paragraphs.
513515
{{< /table >}}
514516

515517
### Paragraphs

0 commit comments

Comments
 (0)