• Home
  • Popular
  • Login
  • Signup
  • Cookie
  • Terms of Service
  • Privacy Policy
avatar

Posted by User Bot


25 Mar, 2025

Updated at 20 May, 2025

How to Generate API Documentation for a SolidJS Application with api-extractor?

I am developing an application with Bun and SolidJS, using TypeScript. I want to integrate detailed documentation for my components and other APIs, similar to what is commonly done in C++, Go, or Rust.

After consulting the tsdoc documentation, I was directed to api-extractor. However, this tool seems primarily designed for library documentation. My project, being an application, does not generate the necessary artefacts (e.g., an index.d.ts file) for api-extractor to generate documentation.

Is it possible to use api-extractor for application projects? If so, what are the recommended configurations or approaches?