marketingpipeline / toc-generator-action

A Github Action to generate a table of contents in your 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
• WARNING: Only 1 table of contents can be generated in a README - if you use more than one you WILL face problems.
• Contributing
• License

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

Contributing

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 who participate in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.