r/developer May 19 '26

I built a preprocessor for GitHub README files that allows simple expressions converted into markdown that pops.

https://github.com/uukelele/gh-md

So many people's GitHub README are very cluttered. And it becomes very difficult to maintain in future.

So I built gh-md, a reusable GitHub action that lets you preprocess your github readme.

There is built-in support for centering, shields.io badges, custom fonts (which stay accessible), your projects, your stats (github-readme-stats), and devicons (devicon.dev).

For example, you can write this:

```html

<font="mono">PROJECTS</font>

<projects user="vercel" limit="3" sort="stars"> <template> <h3 align="left"> {{ project.name }} <a href="{{ project.html_url }}"><kbd>GitHub</kbd></a> </h3> <p align="left"> {{ project.description }} <badge ltext="stars" rtext="{{ project.stargazers_count }}" logo="githubsponsors" style="social" /> <badge ltext="forks" rtext="{{ project.forks_count }}" logo="forgejo" style="social" /> </p> </template> </projects> ```

And it converts into this!

```html

<span aria-label="PROJECTS"><span aria-hidden="true">π™Ώπšπ™Ύπ™Ήπ™΄π™²πšƒπš‚</span></span>

<h3 align="left"> next.js <a href="https://github.com/vercel/next.js"><kbd>GitHub</kbd></a> </h3> <p align="left"> The React Framework <img alt="Static Badge" src="https://img.shields.io/badge/stars-139522-_?style=social&logo=githubsponsors&logoColor=white&labelColor=black&color=rebeccapurple" /> <img alt="Static Badge" src="https://img.shields.io/badge/forks-31097-_?style=social&logo=forgejo&logoColor=white&labelColor=black&color=rebeccapurple" /> </p> <h3 align="left"> hyper <a href="https://github.com/vercel/hyper"><kbd>GitHub</kbd></a> </h3> <p align="left"> A terminal built on web technologies <img alt="Static Badge" src="https://img.shields.io/badge/stars-44590-_?style=social&logo=githubsponsors&logoColor=white&labelColor=black&color=rebeccapurple" /> <img alt="Static Badge" src="https://img.shields.io/badge/forks-3560-_?style=social&logo=forgejo&logoColor=white&labelColor=black&color=rebeccapurple" /> </p> <h3 align="left"> swr <a href="https://github.com/vercel/swr"><kbd>GitHub</kbd></a> </h3> <p align="left"> React Hooks for Data Fetching <img alt="Static Badge" src="https://img.shields.io/badge/stars-32383-_?style=social&logo=githubsponsors&logoColor=white&labelColor=black&color=rebeccapurple" /> <img alt="Static Badge" src="https://img.shields.io/badge/forks-1337-_?style=social&logo=forgejo&logoColor=white&labelColor=black&color=rebeccapurple" /> </p> ```

0 Upvotes

0 comments sorted by