|
1 | 1 | ---
|
2 |
| -title: About READMEs |
| 2 | +title: About the repository README file |
| 3 | +shortTitle: About READMEs |
3 | 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.'
|
4 | 5 | redirect_from:
|
5 | 6 | - /articles/section-links-on-readmes-and-blob-pages
|
@@ -35,25 +36,25 @@ When your README is viewed on GitHub, any content beyond 500 KiB will be truncat
|
35 | 36 |
|
36 | 37 | {% data reusables.profile.profile-readme %}
|
37 | 38 |
|
38 |
| -## Auto-generated table of contents for README files |
| 39 | +## Auto-generated table of contents for markdown files |
39 | 40 |
|
40 | 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.
|
41 | 42 |
|
42 | 43 | 
|
43 | 44 |
|
44 |
| -## Section links in README files and blob pages |
| 45 | +## Section links in markdown files and blob pages |
45 | 46 |
|
46 | 47 | {% data reusables.repositories.section-links %}
|
47 | 48 |
|
48 | 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).
|
49 | 50 |
|
50 |
| -## Relative links and image paths in README files |
| 51 | +## Relative links and image paths in markdown files |
51 | 52 |
|
52 | 53 | {% data reusables.repositories.relative-links %}
|
53 | 54 |
|
54 | 55 | ## Wikis
|
55 | 56 |
|
56 |
| -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). |
57 | 58 |
|
58 | 59 | ## Further reading
|
59 | 60 |
|
|
0 commit comments