Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Open
@fugerit79

Description

@fugerit79

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 (seeGitHub 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp