Skip to content

Commit 9c777bf

Browse files
committed
Add title case style guideline
1 parent 59cd910 commit 9c777bf

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ Shortcodes inside include statements will break the build. You must insert them
449449

450450
Use a single newline to separate block-level content like headings, lists, images, code blocks, and others. The exception is second-level headings, where it should be two newlines. Second-level headings follow the first-level (or the title) without any preceding paragraphs or texts. A two line spacing helps visualize the overall structure of content in a code editor better.
451451

452-
### Headings
452+
### Headings and titles {#headings}
453453

454454
People accessing this documentation may use a screen reader or other assistive technology (AT). [Screen readers](https://en.wikipedia.org/wiki/Screen_reader) are linear output devices, they output items on a page one at a time. If there is a lot of content on a page, you can use headings to give the page an internal structure. A good page structure helps all readers to easily navigate the page or filter topics of interest.
455455

@@ -459,7 +459,13 @@ Do | Don't
459459
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.
460460
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.
461461
Use pound or hash signs (`#`) for non-blog post content. | Use underlines (`---` or `===`) to designate first-level headings.
462-
Use sentence case for headings. For example, **Extend kubectl with plugins** | Use title case for headings. For example, **Extend Kubectl With Plugins**
462+
Use sentence case for headings in the page body. For example, **Extend kubectl
463+
with plugins** | Use title case for headings in the page body. For example,
464+
**Extend Kubectl With Plugins**
465+
Use title case for the page title in the frontmatter. For example,
466+
`title: Kubernetes API Server Bypass Risks` | Use sentence case for page titles
467+
in the frontmatter. For example, don't use
468+
`title: Kubernetes API server bypass risks`
463469
{{< /table >}}
464470

465471
### Paragraphs

0 commit comments

Comments
 (0)