jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 19:06:49 -05:00
Code Issues Projects Releases Wiki Activity

added procedure

Browse Source
This commit is contained in:
Sarita Iyer
2021-04-27 16:59:38 -04:00
parent e5dba93be3
commit 2dcabf52b7
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -44,11 +44,15 @@ If you put your README file in your repository's root, `docs`, or hidden `.githu
### 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.
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.
![README with automatically generated TOC](/assets/images/help/repository/readme-automatic-toc.png)
The auto-generated table of contents is enabled by default for all Markdown files in a repository, and you can disable this feature 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**.
The auto-generated table of contents is enabled by default for all Markdown files in a repository, but you can disable this feature for your repository.
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
1. Under "Features", deselect **Table of contents**.
![Automatic TOC setting for repositories](/assets/images/help/repository/readme-automatic-toc-setting.png)