Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support GitHub relative image URLs #1189

Closed
sindresorhus opened this issue May 7, 2020 · 4 comments
Closed

Support GitHub relative image URLs #1189

sindresorhus opened this issue May 7, 2020 · 4 comments

Comments

@sindresorhus
Copy link

I'm used to be able to use relative image URLs for readme's on GitHub. It would be nice if Jazzy would handle those. Currently, I'm getting broken images when the repo readme is rendered on the generated doc website.

These formats:

  • ![](image.png)
  • <img src="image.png">
@johnfairh
Copy link
Collaborator

If I understand correctly: I think both those formats render fine in the generated html. But there's no way today to tell jazzy about media that needs to be included in the docs, you'll need to copy the files in manually.

@sindresorhus
Copy link
Author

Ideally, Jazzy would see that there are relative images referenced and copy those correctly.

Another solution would be to automatically expand relative URLs to the absolute raw GitHub URL for the assets when github_url is set.

@johnfairh
Copy link
Collaborator

johnfairh commented May 10, 2020

Ok, I did understand. Dup #853.

@sindresorhus
Copy link
Author

I think you linked to the wrong issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants