Skip to content

Markdown rendering issue of text starting with # on changelog page #2869

Closed

Description

@shuuji3

Describe the bug

On change log page, when the sentense starts with # it's rendered as a header. But it should be treated as text.

Example: https://npmx.dev/package-changelog/emojilib/v/4.0.3#release-v3012

screenshot of npmx changelog page showing v3.0.12

The above rendered as

<li><h3 id="user-content-148885754-223-types" data-level="1">223 Types! <a href="#user-content-148885754-223-types"> </a></h3></li>

expected:

<li>#223 Types!</li>

Additional context

GitHub renders it like this:
screenshot of github release page

Logs

Activity

  1. added theissue type on Jun 7, 2026
  2. added
    pending triageNew issue waiting for initial maintainer triage
    frontFrontend, Design
    and removed
    pending triageNew issue waiting for initial maintainer triage
    on Jun 7, 2026
  3. pinned this issue on Jun 7, 2026
  4. unpinned this issue on Jun 7, 2026
  5. ghostdevv commented on Jun 7, 2026

    @ghostdevv
    Member

    Perhaps closed by #2717

  6. gameroman commented on Jun 8, 2026

    @gameroman
    Member

    Perhaps closed by #2717

    Doesn't look to be so

    cc @WilcoSp

  7. WilcoSp commented on Jun 8, 2026

    @WilcoSp
    Contributor

    thanks, when I'm done with work I'll look into how this and hopefully be able to integrate it into #2717

    atm I suspect it could be heading extension that we've to allow for #heading without a space.

  8. WilcoSp commented on Jun 8, 2026

    @WilcoSp
    Contributor

    just fixed it and I was correct with heading extension, I've added an exemption to the heading extension to ignore the #{number} for issues/pr for the changelog markdown renderer.

    preview: https://npmxdev-git-fork-wilcosp-feat-markdown-kit-npmx.vercel.app/package-changelog/emojilib/v/3.0.12

  9. shuuji3 commented on Jun 9, 2026

    @shuuji3
    MemberAuthor

    @WilcoSp Thanks for the quick fix. Looks perfect! 💯 😀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    frontFrontend, Design

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions