Skip to content

Commit b8c6c8b

Browse files
committed
Incorporate comment
1 parent 9dd7ee3 commit b8c6c8b

File tree

1 file changed

+12
-4
lines changed
  • contributing/documentation/style-guide

1 file changed

+12
-4
lines changed

contributing/documentation/style-guide/images.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,30 @@ Use the following markdown syntax to insert images:
4141

4242
### Image with Caption
4343

44-
```markdown
44+
```md
4545
![Caption](../images/sample.png)
4646
```
4747

48-
* Image with Alt Text (Markdown/GitHub):
48+
### Image with Alt Text (Markdown/GitHub)
4949

50-
```markdown
50+
```md
5151
![Alt text describing the image](images/img.png)
5252
```
5353

54-
* Image with Alt Text (GitBook)
54+
### Image with Alt Text
55+
56+
Images added through the GitBook platform are automatically inserted using HTML syntax, as shown in the example below:
5557

5658
```html
5759
<figure><img src="../images/sample.png" alt="The New Backoffice"></figure>
5860
```
5961

62+
However, when contributing to the documentation via GitHub, it is recommended to use Markdown for images instead:
63+
64+
```md
65+
![The New Backoffice](../images/sample.png)
66+
```
67+
6068
{% hint style="info" %}
6169
Always provide alt text or a caption to describe the image’s purpose and content.
6270
{% endhint %}

0 commit comments

Comments
 (0)