Skip to content

Commit 04e574e

Browse files
authored
Update README.md with instruction on adding image
Signed-off-by: Vivek Vishal <[email protected]>
1 parent 0bef5a9 commit 04e574e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,11 @@ The significant keys in the YAML frontmatter are:
160160

161161
### Uploading Images to the site
162162

163-
To display images in a pop-up modal, use the following syntax: `![alt text](/path/to/image.svg)`.
163+
To display images in a pop-up modal, use the following syntax: `![alt text](/path/to/image.svg)` or `<img src="" alt="" />`.
164164

165-
**Note-> For images to show correctly on subpages, always provide the complete image path**
165+
**Note:**
166+
- For images to show correctly on subpages, always provide the complete image path.
167+
- When using the `<img />` tag, add `data-modal="false"` to prevent the image from opening in a modal e.g. a [logo](https://github.com/layer5io/docs/blob/0bef5a9a05214a9dda10d8a68431e41f5a36676d/layouts/partials/footer.html#L9).
166168

167169
### Adding Alert to the site
168170

0 commit comments

Comments
 (0)