markdown-toc icon indicating copy to clipboard operation
markdown-toc copied to clipboard

Add CLI option --check to check whether the TOC is up to date

Open akheron opened this issue 6 years ago • 3 comments

This is useful in CI to check whether TOC was updated or not when changing the headings in a markdown file.

akheron avatar Aug 13 '19 08:08 akheron

I also documented the new option in .verb.md as instructed in the readme, but running verb changed README.md considerably (effectively broke it). Is there something I missed, or should I just not run verb and add the change to README.md by hand instead?

akheron avatar Aug 13 '19 08:08 akheron

This would be great to have as part of CI checks, to see if a PR is lacking to update the TOC. Any chance we can have this, or can be achieve already in some other way? I checked but didn't find much.

joaopgrassi avatar Feb 29 '24 12:02 joaopgrassi