8000 Use relative links for internal content by dideler · Pull Request #11 · tiimgreen/github-cheat-sheet · GitHub
[go: up one dir, main page]

Skip to content

Use relative links for internal content #11

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

Merged
merged 1 commit into from
Apr 13, 2014
Merged

Use relative links for internal content #11

merged 1 commit into from
Apr 13, 2014

Conversation

dideler
Copy link
Contributor
@dideler dideler commented Apr 13, 2014

Relative links should be preferred.

Absolute links are not recommended because

  • they're very long which makes them harder to read
  • will have to update all the links if
    • the repo is forked
    • the owner of the repo changes
    • the owner's username changes
    • the repo is renamed

For more info, see https://help.github.com/articles/relative-links-in-readmes

P.S. A section on relative links might be useful.

Relative links should be preferred.

Absolute links are not recommended because
- they're so long which makes them harder to read
- will have to update all the links if
  - the repo is forked
  - the owner of the repo changes
  - the own
8000
er's username changes
  - the repo is renamed

For more info, see https://help.github.com/articles/relative-links-in-readmes

P.S. A section on relative links might be useful.
@dideler
Copy link
Contributor Author
dideler commented Apr 13, 2014

Links have been manually tested and work.

tiimgreen added a commit that referenced this pull request Apr 13, 2014
Use relative links for internal content
@tiimgreen tiimgreen merged commit c31b126 into tiimgreen:master Apr 13, 2014
@dideler dideler deleted the patch-1 branch April 13, 2014 18:59
@tiimgreen
Copy link
Owner

Feel free to create a Pull Request for relative links. 👍

@dideler
Copy link
Contributor Author
dideler commented Apr 13, 2014

@tiimgreen is there a spot where you would prefer it?

I noticed the markdown content is spread around. Not sure if the plan is to eventually put all of it under a markdown section. In the meantime, I guess I can put it near the TODO list section.

@tiimgreen
Copy link
Owner

Yeah, it was sort of created on the fly so things are a little spread out, put it wherever you think it best. I'll tidy things up later.

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

Successfully merging this pull request may close these issues.

2 participants
0