You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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:
To bold :
This approach would simplify the TOC by limiting it to the main version entries.
A few notes:
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 :
To :
It seems to me this format has a couple of benefits :
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
The text was updated successfully, but these errors were encountered: