Skip to content

Commit

Permalink
Add bold and italic format guidance (#384)
Browse files Browse the repository at this point in the history
* Add bold and italic format guidance

* Add trailing newline

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/write/style-guide/style-conventions/index.md

Co-authored-by: J Stickler <julie.stickler@grafana.com>

* Update docs/sources/write/style-guide/style-conventions/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/write/style-guide/style-conventions/index.md

Co-authored-by: J Stickler <julie.stickler@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
  • Loading branch information
3 people authored Jan 12, 2024
1 parent c7386dc commit 55e1a9a
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 @@ -253,3 +253,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

It's a good idea to take 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.

For example:

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

0 comments on commit 55e1a9a

Please sign in to comment.