Skip to content

Commit

Permalink
chore: add information regarding absolute path in README.md [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
hugo-sid authored Dec 6, 2023
1 parent 4250e01 commit e31a0fb
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit e31a0fb

Please sign in to comment.