Skip to content

Commit

Permalink
Add bold and italic format guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
josmperez committed Nov 16, 2023
1 parent 327ff45 commit 4e7c9b3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/sources/write/style-guide/style-conventions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,3 +244,19 @@ When you write in active voice, you identify the subject of the sentence and the

The output is the same in both cases.
However, the first is easier to review and edit and is less subject to the screen and text editor settings of each contributor.

## Text formatting

Follow a consistent approach to bold, italic, and other text formats.

### Bold

Use bold formatting, ** in Markdown, for UI elements. Don't use bold to draw attention to a word or phrase.

### Italic

Use italics formatting, _ in Markdown, to emphasize a specific word or phrase. This is particularly useful when defining a term for the first time.

**Recommended:** The Prometheus data model is arranged into _metrics_ that consist of a _timestamp_ and a _sample_.

**Not recommended:** The Prometheus data model is arranged into **metrics** that consist of a **timestamp** and a **sample**.

0 comments on commit 4e7c9b3

Please sign in to comment.