Skip to content

[Feature]: Support react-docgen in @rspress/plugin-api-docgen #1290

Open
@SoonIter

Description

What problem does this feature solve?

https://rspress.dev/plugin/official-plugins/api-docgen#apiparsetool

  1. Maintainability, react-docgen is the officital tooling to generate type doc of react component in Facebook, and the last-update of react-docgen-typescript is 2021

  2. More features, analyze nested types and generate documents of nested types, and we can use the playground for better debugging of component-document

img_v3_02da_171de5b0-1ed6-4f51-838e-927763df203g

What does the proposed API look like?

https://rspress.dev/plugin/official-plugins/api-docgen#apiparsetool

  1. use apiParseTool option react-docgen to switch from react-docgen-typescript to react-docgen
  2. We hope to switch the default value of apiParseTool to react-docgen in Rspress 2.0 and generate the component document for our new member of Rstack, Rslib XD

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions