Skip to content

Easily generate readable documentation from your React props and JSDoc comments.

License

Notifications You must be signed in to change notification settings

kubb-labs/docgen

The unplugin-docgen package from Kubb is a Vite/Webpack/Rollup/ESBuild-compatible plugin that extracts TypeScript/React component prop types and JSDoc metadata into a machine-readable format that could be used in a documentation system(with the use of markdown).


Features

  • 🎨 Extract React Props in a clean, readable format
  • 📚 Parse JSDoc annotations to extract descriptions, tags, and type hints
  • 🏗️ Integrates with major bundlers: Vite, Esbuild, Webpack, Rollup, Rspack

Supporting Kubb

Kubb uses an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:

My sponsors

Contributors Contributors

Star History

Star History Chart

About

Easily generate readable documentation from your React props and JSDoc comments.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published