mirror of
https://github.com/tiimgreen/github-cheat-sheet.git
synced 2025-08-10 18:04:10 +02:00
Add section on relative links in markdown
Recommend the use of relative links over absolute links when linking to internal content.
This commit is contained in:
14
README.md
14
README.md
@@ -28,6 +28,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i
|
||||
- [Merged Branches](#merged-branches)
|
||||
- [Quick Licensing](#quick-licensing)
|
||||
- [TODO Lists](#todo-lists)
|
||||
- [Relative Links](#relative-links)
|
||||
- [.gitconfig Recommendations](#gitconfig-recommendations)
|
||||
- [Aliases](#aliases)
|
||||
- [Auto-correct](#auto-correct)
|
||||
@@ -381,6 +382,19 @@ When they are clicked, they will be updated in the pure Markdown:
|
||||
- [ ] Sleep
|
||||
```
|
||||
|
||||
## Relative Links
|
||||
|
||||
[Relative links](https://help.github.com/articles/relative-links-in-readmes) are recommended in your Markdown files when linking to internal content.
|
||||
|
||||
```markdown
|
||||
[Link to a header](#awesome-section)
|
||||
|
||||
[Link to a file](docs/readme)
|
||||
```
|
||||
|
||||
Absolute links have to be updated whenever the URL changes (e.g. repo renamed, username changed, project forked).
|
||||
Using relative links makes your documentation easily stand on its own.
|
||||
|
||||
## .gitconfig Recommendations
|
||||
|
||||
Your `.gitconfig` is the file that contains all your preferences.
|
||||
|
Reference in New Issue
Block a user