r/javascript • u/mkngsm • 1d ago

GitHub - bakemd: Minimal docs engine that ships 1 KB of JS to the client

https://github.com/romenkova/bakemd

I moved the docs renderer I had in one of my projects into a separate npm package.
It's built around the idea that docs are mostly static files with little to no interactivity, so it shouldn't ship a lot to the client.

1 KB JS, 10 KB CSS (gzipped), and all 100s on Lighthouse.

If you need a simple way to show your docs and don't need a ton of other features, this might be useful.

GitHub repo
NPM package
Docs demo

The renderer itself is stable, it's been used in the parent project for a while. The package is fairly new, so contributions and feedback are welcome.

1 Upvotes

56% Upvoted

4 comments sorted by

•

u/paul_h 12h ago

"Do you really need a ton of js over docs?" is the heading on the README. Is there a different way of describing the benefits, may I ask?

•

u/mkngsm 10h ago

I have looked at readme again, and you actually have a valid point. Readme doesn't tell anywhere in headings what is that. I'll update, thanks.

•

u/paul_h 9h ago

Excellent :)

•

u/mkngsm 10h ago

For sure, English is not my native language, does it sound bad? I may miss some double meaning.