Skip to content

Commit 90ac860

Browse files
committed
Added initial draft changes for automatic TOC info
1 parent dbf5f90 commit 90ac860

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,16 @@ 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
46+
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.
48+
49+
<TBD INSERT screenshot of readme with icon?>
50+
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>
54+
4555
### Section links in README files and blob pages
4656

4757
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 %}

0 commit comments

Comments
 (0)