Skip to content

Commit d9ebb0b

Browse files
committed
added screenshots and updated language
1 parent 90ac860 commit d9ebb0b

3 files changed

Lines changed: 6 additions & 7 deletions

File tree

35 KB
Loading
175 KB
Loading

content/github/creating-cloning-and-archiving-repositories/about-readmes.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,18 @@ If you put your README file in your repository's root, `docs`, or hidden `.githu
4242

4343
{% endif %}
4444

45-
### Automatic table of contents in README files
45+
### Auto-generated table of contents in README files
4646

47-
For README files located in the root of a repository, a table of contents will be automatically generated based on headings. You can view the table of contents for a README by clicking on the {% octicon "list-unordered" aria-label="The unordered list icon" %} icon at the top of the README page.
47+
For any Markdown file in a repository, including README files located in the root of a repository, a table of contents is automatically generated based on section headings. You can view the table of contents for a README by clicking the {% octicon "list-unordered" aria-label="The unordered list icon" %} menu icon at the top left of the rendered README page.
4848

49-
<TBD INSERT screenshot of readme with icon?>
49+
![README with automatically generated TOC](/assets/images/help/repository/readme-automatic-toc.png)
5050

51-
While the automatic table of contents is enabled by default, you can opt out of it for your repository. Go to the main page of your repository and click {% octicon "gear" aria-label="The gear icon" %}**Settings**. Under "Features", unselect **Table of contents**.
52-
53-
<TBD INSERT screenshot of repo setting>
51+
While the auto-generated table of contents is enabled by default for all Markdown files in a repository, you can disable it for your repository. Go to the main page of your repository and click {% octicon "gear" aria-label="The gear icon" %} **Settings**. Under "Features", deselect **Table of contents**.
5452

53+
![Automatic TOC setting for repositories](/assets/images/help/repository/readme-automatic-toc-setting.png)
5554
### Section links in README files and blob pages
5655

57-
Many projects use a table of contents at the start of a README to direct users to different sections of the file. {% data reusables.repositories.section-links %}
56+
{% data reusables.repositories.section-links %}
5857

5958
### Relative links and image paths in README files
6059

0 commit comments

Comments
 (0)