jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

about-readmes.md: Fix to TOC text error in about-readmes.md (#40521)

Browse Source 
Co-authored-by: Sharra-writes <sharra-writes@github.com>
This commit is contained in:
Vmla
2025-09-24 13:40:09 -05:00
committed by GitHub
parent 407e51cbd7
commit 439f6ca14c
1 changed files with 1 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes.md
View File

@@ -38,9 +38,7 @@ When your README is viewed on GitHub, any content beyond 500 KiB will be truncat
## Auto-generated table of contents for markdown files
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.
![Screenshot of the README for a repository. In the upper-left corner, the "Table of contents" dropdown menu (list icon) is expanded.](/assets/images/help/repository/readme-automatic-toc.png)
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 in the top corner of the rendered page.
## Section links in markdown files and blob pages