Skip to content

Feat: Markdown kit for readme, changelog & code#1

Draft
WilcoSp wants to merge 25 commits intofeat/changelog-1from
feat/markdown-kit
Draft

Feat: Markdown kit for readme, changelog & code#1
WilcoSp wants to merge 25 commits intofeat/changelog-1from
feat/markdown-kit

Conversation

@WilcoSp
Copy link
Copy Markdown
Owner

@WilcoSp WilcoSp commented Apr 19, 2026

This pr in specific is only to compare, it won't be merged!

🧭 Context

Currently changelog uses a seperate marked markdown renderer from readme, this pr takes the shared code and makes it into a "markdown kit" so that code that can be shared will be shared

📚 Description

moves shared code for both changelog & readme to a shared markdown kit while still allowing for each to have their unique needs.

Heading have been changed to be more consistent and easier to use by users to the following:

  • ## heading -> <hx><a href="#...>heading</a></hx>
  • ## [Example](https://example.com) -> <hx><a href="https://example.com">Example</a><a href="#...></a></hx>

@WilcoSp
Copy link
Copy Markdown
Owner Author

WilcoSp commented Apr 24, 2026

I'm done combining the code, for readme the tests are 100% with the only one being changed are for heading.

I'm currently writing tests for changelog's markdown renderer for the things that are different compared to readme.

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

Successfully merging this pull request may close these issues.

1 participant