search

ankitskvmdam / clean-jsdoc-theme

A beautifully crafted theme / template for JSDoc 3. https://ankdev.me/clean-jsdoc-theme/v4
https://www.npmjs.com/package/clean-jsdoc-theme
MIT License
168 stars 41 forks source link

Only generate new header ids when the content changes #254

Closed cewert closed 12 months ago

cewert commented 1 year ago

Is your feature request related to a problem? Please describe.

I'm using jsdoc and this github action https://github.com/stefanzweifel/git-auto-commit-action to automatically update the doc files after a PR is merged.

My problem is that because this theme generates new header ids for each file regardless if there has been changes, that means that in order for me to make this workflow work, we would need to update every single doc .html file because of the new ids instead of just the files with changes.

Describe the solution you'd like

Only modify the .html files if there have been changes

Describe alternatives you've considered

Add some kind of config setting to allow users to opt out/in to this behavior

Additional context

These are the ids I'm talking about:

clean-jsdoc-id

github-actions[bot] commented 1 year ago

Wonderful, you have created your first issue for clean-jsdoc-theme. Someone will talk to you soon!

ankitskvmdam commented 1 year ago

Thanks for creating this issue. I will look into this.

ankitskvmdam commented 12 months ago

This issue have been fixed in v4.2.17