Create a table of contents in the CHANGELOG file

mc706 / changelog-cli

A Command Line Interface that makes it easy to manage a helpful Changelog

MIT License

17 stars 15 forks source link

Create a table of contents in the CHANGELOG file #14

Open movermeyer opened 3 years ago

movermeyer commented 3 years ago

Some projects have a table of contents at the top of their CHANGELOGs.

This allows readers to quickly jump to the version they are interested in.

Add some mechanism to request that changelog-cli autogenerate a table of contents?

movermeyer commented 3 years ago

Showerthoughts:

Perhaps this could be added to the changelog by adding a --toc flag to the init command to indicate that you wanted a Table of Contents
After the table of contents exists, you wouldn't need to provide this flag. It would simply update the existing table of contents
I'd probably steal the algorithm for these from https://github.com/yzhang-gh/vscode-markdown, since theirs works well, and I already use that for a bunch of other Markdown projects.

mc706 commented 3 years ago

I like the idea of being able to turn on via a flag and keep it running via feature detection. I have a few projects that have gotten large enough or where we have had to keep non-linear histories where that could be very useful.