https://github.com/activeviam/react-api-documenter
https://github.com/activeviam/react-api-documenter
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/activeviam/react-api-documenter
- Owner: activeviam
- Created: 2020-10-11T19:30:36.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T14:47:58.000Z (about 2 years ago)
- Last Synced: 2024-04-12T22:21:00.420Z (about 2 years ago)
- Language: TypeScript
- Size: 276 KB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React API Documenter
Like [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter), but more tailored to [React](https://reactjs.org/) libraries.
Generates markdown files usable with [Docusaurus](https://v2.docusaurus.io/), from an `api.json` file created by [@microsoft/api-extractor](https://api-extractor.com/).
`@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.