Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optional alternate changelog format to take advantage of GitHub auto Table Of Content #650

Open
fugerit79 opened this issue Mar 12, 2025 · 0 comments

Comments

@fugerit79
Copy link

fugerit79 commented Mar 12, 2025

Hello @olivierlacan,

First of all, thank you for the great work on this project. I use it by default on all my projects and find it very useful.

Since many projects are hosted on GitHub—and as you surely know, GitHub offers many Markdown features like preview and an auto-generated Table of Contents (see GitHub Docs on Headings)—I wanted to propose an optional alternate changelog format. The idea is to have the GitHub TOC display only the version numbers, excluding subsections such as "Changed" or "Added."

For example, instead of using a third-level header:

### Changed

To bold :

**Changed**

This approach would simplify the TOC by limiting it to the main version entries.

A few notes:

  • This could be implemented as the default or as an optional additional changelog format.
  • If the proposal is accepted, I'd be happy to help update any sections or provide a brief documentation and migration guide.

What do you think?

Here are two simple POC,

On your repository :
https://github.com/fugerit-org/keep-a-changelog/blob/github-headings/CHANGELOG.md

And one of my repository :
https://github.com/fugerit-org/fj-doc/blob/312-chore-keep-a-changelog-format-update-for-github-auto-indexing/CHANGELOG.md

Rendering of Table Of Contents changed from :

Image

To :

Image

It seems to me this format has a couple of benefits :

  • Reading the Table Of Contents is more practical, especially when there is a long list of versions
  • Duplicate headers are avoided (for duplicate header auto anchoar may not be stable).

Maybe many users prefer the current format, so the proposal could be just an optional additionl (if accepted).

Thanks in advance,
See you

PS: I also started a PR #651

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant