https://github.com/marketingpipeline/toc-generator-action

A Github Action to generate a table of contents in your README
https://github.com/marketingpipeline/toc-generator-action

gh-action github github-action github-actions github-readme github-workflow github-workflows readme readme-generator table-of-contents table-of-contents-generator toc-generator toc-generator-action

Last synced: 4 months ago
JSON representation

A Github Action to generate a table of contents in your README

• Host: GitHub
• URL: https://github.com/marketingpipeline/toc-generator-action
• Owner: MarketingPipeline
• License: mit
• Created: 2022-07-08T11:32:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-11T05:15:11.000Z (about 3 years ago)
• Last Synced: 2025-04-08T08:44:20.401Z (6 months ago)
• Topics: gh-action, github, github-action, github-actions, github-readme, github-workflow, github-workflows, readme, readme-generator, table-of-contents, table-of-contents-generator, toc-generator, toc-generator-action
• Language: Dockerfile
• Homepage:
• Size: 580 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# TOC-Generator-Action



  





A Github Action to generate table of contents in your README

  

  

   


   Show your support! 

  


   

    

  

  

    

  

     

 


	

## Example and usages

######

 Preview Table Of Contents


 

- [Example and usages](#example-and-usages)

- [WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems.](#warning-only-1-table-of-contents-can-be-generated-in-a-readme---if-you-use-more-than-one-you-will-face-problems)

- [Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/TOC-Generator-Action)](#contributing-githubhttpsimgshieldsiogithubcontributorsmarketingpipelinetoc-generator-action)

- [License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/TOC-Generator-Action)](#license-githubhttpsimgshieldsiogithublicensemarketingpipelinetoc-generator-action)

 
	 	 	




How to generate Table Of Contents:




  

## WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems.   

  

To generate tables of contents automatically use anywhere in your README.md file a comment like so

   

<!-- toc -->

<!-- tocstop -->

 
	 




 View Example Workflow Usage 





    - uses: actions/checkout@v2

    - uses: MarketingPipeline/TOC-Generator-Action@main

    - name: Commit and Push Updated Table Of Contents

      run: |

         git config --global user.name "github-actions[bot]"

         git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"

         git add README.md

         git commit -m "Updated Table Of Contents"

         git push

         




Example [workflow file](.github/workflows/example_workflow.yaml)         

## Contributing ![GitHub](https://img.shields.io/github/contributors/MarketingPipeline/TOC-Generator-Action)

Want to imrpove this action? Create a pull request with described in detail with your changes! If approved you will be added to the list of contributors of this awesome project!

See also the list of

[contributors](https://github.com/MarketingPipeline/TOC-Generator-Action/graphs/contributors) who

participate in this project.

## License ![GitHub](https://img.shields.io/github/license/MarketingPipeline/TOC-Generator-Action)

This project is licensed under the MIT License - see the

[LICENSE.md](https://github.com/MarketingPipeline/TOC-Generator-Action/blob/main/LICENSE) file for

details.