Discussion
Loading...

Post

  • About
  • Code of conduct
  • Privacy
  • Users
  • Instances
  • About Bonfire
Rob Anderson
@r0b@social.lol  ·  activity timestamp 2 months ago

I've been playing around with streamlining documentation by pulling JSDoc comments straight into an #11ty website. I'll try and write it up once I get it to somewhere I'm a bit happier with.

For example, this page is partially generated based on the comments directly in the JavaScript code

https://gruber.r0b.io/postgres/

https://github.com/robb-j/gruber/blob/main/postgres/postgres-migrator.ts

It's pretty cool, and hopefully makes the documentation so much closer to edit when the code itself changes, Though I think there needs to be more curatability in it.

#Notes#Gruber

  • Copy link
  • Flag this post
  • Block
Log in

bonfire.cafe

A space for Bonfire maintainers and contributors to communicate

bonfire.cafe: About · Code of conduct · Privacy · Users · Instances
Bonfire social · 1.0.0-rc.3.5 no JS en
Automatic federation enabled
  • Explore
  • About
  • Members
  • Code of Conduct
Home
Login