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

Use relative paths for images #340

Closed
sethfischer opened this issue Jul 17, 2021 · 2 comments · Fixed by #345
Closed

Use relative paths for images #340

sethfischer opened this issue Jul 17, 2021 · 2 comments · Fixed by #345
Assignees

Comments

@sethfischer
Copy link
Contributor

Proposal

Make all image src links relative.

Justification

Using relative links allows correct rendering of a local preview. For this reason GitHub's docs recommend using relative links:

Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.

Being able to preview rendered Markdown before pushing is important as it can reduce the number of errors.

Example

In mechanical/head_assembly/README.md there is one relative link, with the remaining being absolute.

The image with the relative link displays in a local preview with the remaining absolute images being broken.

Relative link

| <img src="../../images/components/structural/S43.png" width="50%"> |
| :--: |
| Figure 1: 3D Printed Parts |

relative-image-link

Absolute link

<img src="/images/head/finala.png" width="50%">

absolute-image-link

@sethfischer
Copy link
Contributor Author

If this proposal is accepted I will prepare a pull request.

@ericjunkins
Copy link
Collaborator

Sounds good assigned it to you

sethfischer added a commit to sethfischer/open-source-rover that referenced this issue Jul 27, 2021
sethfischer added a commit to sethfischer/open-source-rover that referenced this issue Jul 29, 2021
@sethfischer sethfischer changed the title Use relative links for images Use relative paths for images Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants