From e31a0fb9c838f35425db19794bf8c10a751d5814 Mon Sep 17 00:00:00 2001 From: Sid <122173059+hugo-sid@users.noreply.github.com> Date: Wed, 6 Dec 2023 07:09:23 +0530 Subject: [PATCH] chore: add information regarding absolute path in README.md [skip ci] --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 85bbfba..5bf5f78 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,16 @@ Your theme's README file (which should be written in Markdown and called `README To make your theme more accessible to users across the globe, it would be helpful if you could include an English translation of the README, at the very least. -> **Note**: If you add screenshots to the README, please make sure to use absolute file paths instead of relative ones (like `/images/screenshot.png`). Relative paths work great on GitHub/GitLab, but they don't correspond to the directory structure of [themes.gohugo.io](https://themes.gohugo.io/) website. Therefore, browsers will not be able to display screenshots if relative paths are used. +### Use absolute paths for images +If you are adding images to README, make sure to use absolute file paths instead of relative paths. + +Examples: + +- Absolute Path: `https://raw.githubusercontent.com/user/repo/branch/images/tn.png` +- Relative Path: `images/example.png` + + +Relative paths work great on GitHub/GitLab, but they don't correspond to the directory structure of [themes.gohugo.io](https://themes.gohugo.io/) website. Therefore, browsers will not be able to display the image if relative path is used. ## Criteria for acceptance of a theme