Skip to content

Commit

Permalink
Merge pull request #48667 from nate-double-u/48662-update-style-guide…
Browse files Browse the repository at this point in the history
…-headers-section

Updating Style Guide Headings and Titles section
  • Loading branch information
k8s-ci-robot authored Nov 17, 2024
2 parents 958ed3b + d13d5c5 commit 75d48f3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions content/en/docs/contribute/style/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,8 @@ Use ordered headings to provide a meaningful high-level outline of your content.
Use pound or hash signs (`#`) for non-blog post content. | Use underlines (`---` or `===`) to designate first-level headings.
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**
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`
Place relevant links in the body copy. | Include hyperlinks (`<a href=""></a>`) in headings.
Use proper heading markers (`---` or `===`) to indicate headings. | Use **bold** text or other indicators to split paragraphs.
{{< /table >}}

### Paragraphs
Expand Down

0 comments on commit 75d48f3

Please sign in to comment.