Skip to content

Commit

Permalink
doc: add alt properties to images
Browse files Browse the repository at this point in the history
  • Loading branch information
jamacku committed Apr 26, 2024
1 parent 40cd364 commit 82657d5
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- markdownlint-disable MD033 MD041 -->
<p align="center">
<img src="https://github.com/redhat-plumbers-in-action/team/blob/70f67465cc46e02febb16aaa1cace2ceb82e6e5c/members/green-plumber.png" width="100" />
<img src="https://github.com/redhat-plumbers-in-action/team/blob/70f67465cc46e02febb16aaa1cace2ceb82e6e5c/members/green-plumber.png" width="100" alt="Differential ShellCheck" />
<h1 align="center">Differential ShellCheck</h1>
</p>

Expand Down Expand Up @@ -111,7 +111,7 @@ jobs:
<details>
<summary>Console output example</summary>
<p align="center">
<img src="docs/images/output-example.png" width="800" />
<img src="docs/images/output-example.png" width="800" alt="Console output example" />
</p>
</details>

Expand All @@ -120,7 +120,7 @@ jobs:
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/images/job-summary-dark.png">
<img src="docs/images/job-summary-light.png" width="600" />
<img src="docs/images/job-summary-light.png" width="600" alt="Example of Job Summary" />
</picture>
</p>
</details>
Expand All @@ -130,7 +130,7 @@ jobs:
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/images/sarif-output-example-dark.png">
<img src="docs/images/sarif-output-example-light.png" width="600" />
<img src="docs/images/sarif-output-example-light.png" width="600" alt="Example of output in Changed files tab" />
</picture>
</p>
</details>
Expand All @@ -140,7 +140,7 @@ jobs:
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/images/sarif-comment-dark.png">
<img src="docs/images/sarif-comment-light.png" width="600" />
<img src="docs/images/sarif-comment-light.png" width="600" alt="Example of @github-code-scanning bot review comment" />
</picture>
</p>
</details>
Expand Down Expand Up @@ -357,11 +357,11 @@ _Code scanning is available for all public repositories on GitHub.com. Code scan
Differential ShellCheck doesn't have a VS Code plugin, but results can be accessed by using [SARIF Viewer](https://marketplace.visualstudio.com/items?itemName=MS-SarifVSCode.sarif-viewer) VS Code extension provided by Microsoft. Once installed, you have to connect your GitHub account with VS Code. Then, if you open a repository that uses Differential ShellCheck, you will see reported defects directly in your VS Code IDE.

<p align="center">
<img src="docs/images/vs-code-sarif-connect-dark.png" width="450" />
<img src="docs/images/vs-code-sarif-connect-dark.png" width="450" alt="VS Code SARIF connect" />
</p>

<p align="center">
<img src="docs/images/vs-code-sarif-results-dark.png" width="550" />
<img src="docs/images/vs-code-sarif-results-dark.png" width="550" alt="VS Code SARIF results" />
</p>

## Limitations
Expand Down

0 comments on commit 82657d5

Please sign in to comment.