Skip to content

RiskyMH/bun-docs

Repository files navigation

Bun Documentation

Alternative documentation for Bun: the fast, all-in-one JavaScript runtime.

Official is https://bun.com/docs (mintlify)

This is https://bun-docs.vercel.app/docs (fumadocs)

Development

$ bun dev

Open http://localhost:3000 with your browser to see the result.

Contributing

For most documentation changes, contribute upstream at Bun Docs.

  • If your change applies generally to the docs (not specific to this fork), submit it upstream.
  • If your change is specific to this fork (e.g. migration fixes, custom features, metadata edge cases), update manual-fixes.patch so your fix persists after future syncs:
    • After making your changes locally and running the migration, re-generate the patch: git add . && bun sync-docs:save
    • This ensures any non-standard or custom doc changes survive future doc syncs.

Extra info

TODO:

  • full metadata of what og (both custom docs & mintlify one) had
  • if subdir and no page that level, redirect to first child page (ie /guides/ecosystem -> /guides/ecosystem/astro)

About

Better docs ui than https://bun.com/docs - ie fumadocs > mintlify

Topics

Resources

Stars

Watchers

Forks

Languages