You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
| <imgsrc="../../images/components/structural/S43.png"width="50%"> || :--: || Figure 1: 3D Printed Parts |
Absolute link
<imgsrc="/images/head/finala.png"width="50%">
The text was updated successfully, but these errors were encountered:
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:
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
Absolute link
The text was updated successfully, but these errors were encountered: