Parse comments as Story description #154
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
|
🚀 PR was released in |
|
This is pretty cool, I like the solution! ❤️ Now we just need to support JSDoc comments above the meta definition for component-level descriptions. https://storybook.js.org/docs/react/api/doc-block-description#writing-descriptions |
|
It should be easy to do. But it won't work with typescript or a preprocessor. They are working on native typescript parsing. it will help with this kind of issue, or with doc generation I think. |
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.
This PR allows to inject comments as Story description, as suggested by #148 :
the description is injected into 'parameters.docs.description.story'