jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-28 18:03:28 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #9103 from github/repo-sync

Browse Source 
repo sync
This commit is contained in:
Octomerger Bot
2021-08-18 02:33:03 +10:00
committed by GitHub
parent b9cfad9f71 e0a7c47a6d
commit 8a9451d8db
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes.md
View File

@@ -42,6 +42,8 @@ If you put your README file in your repository's root, `docs`, or hidden `.githu
{% endif %}
{% ifversion fpt or ghae-next or ghes > 3.1 %}
## Auto-generated table of contents for README files
For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.product_name %} 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="The unordered list icon" %} menu icon at the top left of the rendered page.
@@ -55,6 +57,8 @@ The auto-generated table of contents is enabled by default for all Markdown file
1. Under "Features", deselect **Table of contents**.
![Automatic TOC setting for repositories](/assets/images/help/repository/readme-automatic-toc-setting.png)
{% endif %}
## Section links in README files and blob pages
{% data reusables.repositories.section-links %}