Adding docs to Button and migrating to MDX #762
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✔️ Deploy Preview for storeui ready! 🔨 Explore the source changes: cd1a504 🔍 Inspect the deploy log: https://app.netlify.com/sites/storeui/deploys/60ca6c1e62d08700087163e9 😎 Browse the preview: https://deploy-preview-762--storeui.netlify.app/iframe |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit cd1a504:
|
|
Muito Bom! |
|
Is there a way of making the code beautiful too? |
Gmantiqueira
force-pushed
the
storybook/button-docs
branch
from
b09ed38 to
fdfae10
Compare
Thanks, this happens when I use an intermediate variable. It's fixed.
|
tlgimenes
approved these changes
Jun 14, 2021
tlgimenes
reviewed
Jun 15, 2021
bentoper
pushed a commit
that referenced
this pull request
Jun 17, 2021
* Adding docs to Button and migrating to MDX * Fix optional typing * Fix show code content * Fix prop description * Removing href prop from button * Removing href and as props
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's the purpose of this pull request?
I think we can't write a scalable, good and accessible documentation with the TSX format. MDX make it more accessible for other people to suggest or add more information to our components and adds some more things that we can do with Markdown + JSX.
How it works?
This PR adds an example of MDX story for Storybook and creates docs for Button. I'll migrate the other components if this PR makes sense.
How to test it?
https://deploy-preview-762--storeui.netlify.app/?path=/docs/atoms-button--button
References
Storybook MDX docs