refactor(utils): use build-md for markdown formatting

[matejchalk]

I've published a library called build-md for dynamically rendering Markdown documents 🚀

I refactored our Markdown rendering logic to use this library. The advantage is our logic now focuses on document semantics, and is no longer concerned with Markdown formatting rules (like where to add separator lines and what to indent). The library's Markdown output is better formatted (fewer Markdown lint violations) - HTML is only used when necessary (context-sensitive rendering), there are no extra or missing separator lines, and the table columns are automatically aligned (as if by Prettier).

---

The reason I want this to be a standalone library is because it's applicable to other projects as well like @code-pushup/eslint-config (migrated in code-pushup/eslint-config@8ac8793) or zod2md (migration planned).

[github-actions]

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared target commit 0dfbb15 with source commit d45213d.

🏷️ Categories

🏷️ Category	⭐ Previous score	⭐ Current score	🔄 Score change
Performance	🟡 55	🟡 54
Updates	🟡 78	🟡 79
Code coverage	🟡 89	🟡 90
Accessibility	🟢 91	🟢 91	–
Best Practices	🟢 100	🟢 100	–
SEO	🟡 61	🟡 61	–
Bug prevention	🟢 100	🟢 100	–
Code style	🟢 99	🟢 99	–
Security	🟢 100	🟢 100	–
Custom checks	🟡 67	🟡 67	–

🗃️ Groups

👍 2 groups improved, 👎 1 group regressed

🔌 Plugin	🗃️ Group	⭐ Previous score	⭐ Current score	🔄 Score change
Lighthouse	Performance	🟡 55	🟡 54
JS Packages	NPM outdated dependencies	🟡 78	🟡 79
Code coverage	Code coverage metrics	🟡 89	🟡 90

17 other groups are unchanged.

🛡️ Audits

👍 4 audits improved, 👎 5 audits regressed, 14 audits changed without impacting score

🔌 Plugin	🛡️ Audit	📏 Previous value	📏 Current value	🔄 Value change
Lighthouse	Speed Index	🟥 6.4 s	🟨 5.3 s
Lighthouse	Largest Contentful Paint	🟨 2.9 s	🟨 3.2 s
Lighthouse	First Contentful Paint	🟨 2.8 s	🟨 2.9 s
Lighthouse	First Meaningful Paint	🟨 2.8 s	🟨 2.9 s
Lighthouse	Time to Interactive	🟥 16.4 s	🟥 17.1 s
JS Packages	Outdated NPM prod dependencies.	🟨 13 outdated package versions (4 major, 3 minor, 6 patch)	🟨 13 outdated package versions (4 major, 3 minor, 6 patch)
Code coverage	Function coverage	🟩 91.9 %	🟩 92.3 %
Code coverage	Branch coverage	🟨 83.4 %	🟨 83.7 %
Code coverage	Line coverage	🟩 91.9 %	🟩 91.7 %
Lighthouse	Total Blocking Time	🟥 7,360 ms	🟥 8,870 ms
Lighthouse	Max Potential First Input Delay	🟥 2,900 ms	🟥 3,930 ms
Lighthouse	JavaScript execution time	🟥 9.5 s	🟥 10.4 s
Lighthouse	Metrics	🟩 16429	🟩 17059
Lighthouse	Avoids enormous network payloads	🟩 Total size was 1,786 KiB	🟩 Total size was 1,785 KiB
Lighthouse	Eliminate render-blocking resources	🟥 Potential savings of 810 ms	🟥 Potential savings of 1,310 ms
Lighthouse	Uses efficient cache policy on static assets	🟨 27 resources found	🟨 27 resources found
Lighthouse	Reduce unused CSS	🟥 Potential savings of 105 KiB	🟥 Potential savings of 105 KiB
Lighthouse	Initial server response time was short	🟩 Root document took 460 ms	🟩 Root document took 340 ms
Lighthouse	Server Backend Latencies	🟩 220 ms	🟩 130 ms
Lighthouse	Minimizes main-thread work	🟥 20.5 s	🟥 20.6 s
Lighthouse	Network Round Trip Times	🟩 50 ms	🟩 20 ms
Lighthouse	Avoids an excessive DOM size	🟥 2,187 elements	🟥 2,186 elements
Lighthouse	Cumulative Layout Shift	🟩 0	🟩 0

486 other audits are unchanged.

[BioPhoton]

Really good!! It's funny that I thought about that area yesterday.
Can we maybe move the lib into our org?

[matejchalk]

Can we maybe move the lib into our org?

I built this library in my free time, and it has applications beyong Code PushUp (e.g. zod2md), so I want to keep it under my account.

[Tlacenka]

The markdown composition is much more readable now 👏

[Tlacenka]

💯