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

Besides checking for .md files, also check for `.github/toc.yml`

Open gr2m opened this issue 7 years ago • 4 comments

I’ve setup toc-me for https://github.com/nock/nock/. We decided to change the bullets using the configuration and I expected toc-me to update the README again, but it didn’t, because it only does when a *.md file was updated.

I wonder if you would consider checking for .github/toc.yml as well?

gr2m avatar Jan 06 '19 18:01 gr2m

Welcome! Thanks for opening your first issue in toc-me.

welcome[bot] avatar Jan 06 '19 18:01 welcome[bot]

@gr2m - I'm glad to see you are finding value in my little app. I like your suggestion and would welcome your thoughts on this potential approach:

  • The app checks to see if a commit includes a change to .github/toc.yml
  • If a config change is applied, the search API is used to find all markdown files in the repo
  • The app re-generates TOCs in properly configured README files

Would this address your needs?

pholleran avatar Jan 11 '19 03:01 pholleran

Yes, that sounds great!

gr2m avatar Jan 11 '19 04:01 gr2m

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

stale[bot] avatar Jan 25 '19 05:01 stale[bot]