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.

Sign up for GitHub

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

Jump to bottom

Start using .mdx files to be more descriptive in stories #68

Closed
2 tasks done
ChromeGG opened this issue Jul 6, 2022 · 3 comments
Closed
2 tasks done

Start using .mdx files to be more descriptive in stories #68

ChromeGG opened this issue Jul 6, 2022 · 3 comments

Comments

@ChromeGG
Copy link

ChromeGG commented Jul 6, 2022 •
edited
Loading

Duplicates

  • I have searched the existing issues

Latest version

  • I have tested the latest version

Summary 💡

MDX is a more robust format for documentation. With this, we can easily describe what the component does and add a link to MUI/RHF documentation.

Examples 🌈

See:
https://storybook.js.org/docs/react/writing-docs/mdx

I can do it on Sunday or next week 😄
@dohomi
Copy link
Owner

dohomi commented Jul 7, 2022

sounds great! I'll try to join next week this week is very busy for me

@ChromeGG
Copy link
Author

ChromeGG commented Jul 10, 2022 •
edited
Loading

@dohomi I did some progress with transforming .tsx stories to .mdx stories. You can track progress #72

image

Btw. I found sth interesting. You asked about this. There are two plugins that could help us. Take a look here

@dohomi
Copy link
Owner

dohomi commented May 15, 2023

After moving of v7 of storybook I will try to improve it differently.

@dohomi dohomi closed this as completed May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dohomi @ChromeGG