Skip to content

rgosse/react-api-documenter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React API Documenter

Like @microsoft/api-documenter, but taylored for 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.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 99.5%
  • JavaScript 0.5%