File tree Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Expand file tree Collapse file tree 1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change @@ -28,6 +28,7 @@ All the hidden and not hidden features of Git and GitHub. This cheat sheet was i
28
28
- [ Merged Branches] ( #merged-branches )
29
29
- [ Quick Licensing] ( #quick-licensing )
30
30
- [ TODO Lists] ( #todo-lists )
31
+ - [ Relative Links] ( #relative-links )
31
32
- [ .gitconfig Recommendations] ( #gitconfig-recommendations )
32
33
- [ Aliases] ( #aliases )
33
34
- [ Auto-correct] ( #auto-correct )
@@ -381,6 +382,19 @@ When they are clicked, they will be updated in the pure Markdown:
381
382
- [ ] Sleep
382
383
```
383
384
385
+ ## Relative Links
386
+
387
+ [ Relative links] ( https://help.github.com/articles/relative-links-in-readmes ) are recommended in your Markdown files when linking to internal content.
388
+
389
+ ``` markdown
390
+ [Link to a header](#awesome-section)
391
+
392
+ [Link to a file](docs/readme)
393
+ ```
394
+
395
+ Absolute links have to be updated whenever the URL changes (e.g. repo renamed, username changed, project forked).
396
+ Using relative links makes your documentation easily stand on its own.
397
+
384
398
## .gitconfig Recommendations
385
399
386
400
Your ` .gitconfig ` is the file that contains all your preferences.
You can’t perform that action at this time.
0 commit comments