Skip to content

Latest commit

 

History

History
10 lines (6 loc) · 741 Bytes

README.md

File metadata and controls

10 lines (6 loc) · 741 Bytes

React API Documenter

Like @microsoft/api-documenter, but more tailored to React libraries.

Generates markdown files usable with Docusaurus, from an api.json file created by @microsoft/api-extractor.

@microsoft/api-documenter is great, but in the context of React libraries, its output can be improved:

  • It groups exports under categories, that would make more sense if they were more specific (e.g. Functions => Hooks, Components, Functions)
  • It creates one page per export, but the documentation would be more usable if Components and their props were grouped in a single page.