Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support auto generate react component docs #515

Merged
merged 11 commits into from
Apr 3, 2023

Conversation

luhc228
Copy link
Member

@luhc228 luhc228 commented Mar 29, 2023

Ref: #436

使用方式:

在 markdown 文件中添加以下的组件 <ReactDocgenProps />

<ReactDocgenProps path="../src/components/index.tsx"></ReactDocgenProps>

@ice/remark-react-docgen-docusaurus 会自动识别到 <ReactDocgenProps /> 组件并自动替换成 Props 文档

效果预览:

image

@luhc228 luhc228 requested a review from wssgcg1213 March 29, 2023 12:01
@luhc228 luhc228 self-assigned this Mar 29, 2023
@vercel
Copy link

vercel bot commented Mar 29, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
icepkg ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Mar 30, 2023 at 6:43AM (UTC)

@luhc228 luhc228 requested a review from ChrisCindy March 29, 2023 12:01
@luhc228 luhc228 changed the title [WIP] feat: support auto generate react component docs feat: support auto generate react component docs Mar 30, 2023
@luhc228 luhc228 merged commit 2b01e99 into release-next Apr 3, 2023
@luhc228 luhc228 deleted the feat/support-generate-react-doc branch April 3, 2023 11:01
This was referenced Apr 7, 2023
luhc228 added a commit that referenced this pull request Apr 10, 2023
* feat: support auto generate react component docs

* chore: update README

* fix: lint

* chore: update version

* chore: version

* chore: changeset

* chore: reset preset order

* chore: remove custom css

* docs: update preview

* chore: update example

* docs: update README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need review Need Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants