Skip to content

Commit

Permalink
Demonstrate best practice for image "Alt text" in Style Guide (#4101)
Browse files Browse the repository at this point in the history
* Demonstrate best practice for image "Alt text" in Style Guide

* Update documentation/style-guide.md

---------
  • Loading branch information
Jamesllllllllll authored Dec 19, 2023
1 parent 54d46c6 commit 7bf53a4
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions documentation/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,8 @@ Codebytes can be used with the following languages:
- File names should be in lowercase.
- Images should be used for diagrams, UI illustrations, and showing output to the user.
- Images should not be used to illustrate code. [Code blocks](#code) should be used instead.
- Use descriptive "Alt text" with images to describe the image, diagram, or animation.
- The "Alt text" should be in square brackets, before the URL in an image tag: `![Text that describes the image, diagram, or animation](https://path.to/image)`

> **Note:** Image links will not work until a PR is merged.
Expand Down

0 comments on commit 7bf53a4

Please sign in to comment.