Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sharra-writes merged 2 commits into from
Sep 24, 2025
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06ef9e1
Fix to TOC text error in about-readmes.md
VimalaMoger Sep 23, 2025
45d23bb
Merge branch 'main' into feature
Sharra-writes Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions ...-repositorys-settings-and-features/customizing-your-repository/about-readmes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading