Skip to content

Commit 723a72f

Browse files
authored
Content strategy bug fix 2024-01-17 (#48743)
1 parent f6df08e commit 723a72f

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

content/contributing/style-guide-and-content-model/style-guide.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,29 @@ Note that regardless of the identifier you use (letters, words), footnotes will
254254

255255
Headers must adequately describe the content under them. Headers can either follow the guidelines for writing titles or can be written as questions. Use sentence casing for headers. Each header on a page must be unique.
256256

257-
Use H2 for headers and H3 for subheaders. If an article has headers, the headers must start with an H2 level header and cannot skip header levels. There must be text content between a header and subheader, such as an introduction. When referring to headers, surround the header name with quotation marks.
257+
If an article has headers, the headers must start with an H2 level header. You can use H3 and H4 level headers to further organize content into related groups, but you cannot skip header levels. There must be text content between a header and subheader, such as an introduction.
258+
- **Use:**
259+
260+
```markdown
261+
## HEADER (H2)
262+
TEXT
263+
264+
### SUBHEADER (H3)
265+
TEXT
266+
267+
#### SUBHEADER (H4)
268+
TEXT
269+
```
270+
271+
- **Avoid:**
272+
273+
```markdown
274+
## HEADER (H2)
275+
276+
#### SUBHEADER (H4)
277+
```
278+
279+
When referring to headers, surround the header name with quotation marks.
258280
- **Use:** Under "User licenses," view your total licenses.
259281

260282
For more information, see the "[AUTOTITLE](/contributing/style-guide-and-content-model/contents-of-a-github-docs-article)."

0 commit comments

Comments
 (0)