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
Copy file name to clipboardExpand all lines: content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Repository README file
2
+
title: Using a repository README file
3
3
shortTitle: About READMEs
4
4
intro: 'You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.'
5
5
redirect_from:
@@ -15,7 +15,7 @@ versions:
15
15
topics:
16
16
- Repositories
17
17
---
18
-
## About the repository README file
18
+
## About READMEs
19
19
20
20
{% data reusables.repositories.about-READMEs %}
21
21
@@ -36,25 +36,25 @@ When your README is viewed on GitHub, any content beyond 500 KiB will be truncat
36
36
37
37
{% data reusables.profile.profile-readme %}
38
38
39
-
## Auto-generated table of contents for README files
39
+
## Auto-generated table of contents for markdown files
40
40
41
41
For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.github %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="Table of Contents" %} menu icon at the top left of the rendered page.
42
42
43
43

44
44
45
-
## Section links in README files and blob pages
45
+
## Section links in markdown files and blob pages
46
46
47
47
{% data reusables.repositories.section-links %}
48
48
49
49
For more detailed information about section links, see [Section links](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links).
50
50
51
-
## Relative links and image paths in README files
51
+
## Relative links and image paths in markdown files
52
52
53
53
{% data reusables.repositories.relative-links %}
54
54
55
55
## Wikis
56
56
57
-
A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see [AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis).
57
+
A README should only contain information necessary for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see [AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis).
0 commit comments