Self Explanatory Code?
I created documentation for a project and needed to mark a thing or two on the code samples. Instead of using comments, I created a tiny script that attach floating labels where I need.
My coworkers ask for those “scripts” — so instead, I created this tiny package, a transformer for Shiki that add floating labels where ever I need them.
This package allow you to add floating label in the Shiki code blocks with specific comments format. It can be used in Vitepress as in any other Shiki integration.
Get Ziv Perry’s stories in your inbox
Join Medium for free to get updates from this writer.
For any comment or suggestion, do not hesitate to contact me.
And enjoy annotating your code samples.
A message from our Founder
Hey, Sunil here. I wanted to take a moment to thank you for reading until the end and for being a part of this community.
Did you know that our team run these publications as a volunteer effort to over 3.5m monthly readers? We don’t receive any funding, we do this to support the community. ❤️
If you want to show some love, please take a moment to follow me on LinkedIn, TikTok, Instagram. You can also subscribe to our weekly newsletter.
And before you go, don’t forget to clap and follow the writer️!
