question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Use Markdown to style props description in the PropsTable

See original GitHub issue

Is your feature request related to a problem? Please describe. With addon-docs, it’s already possible to style the component description using markdown in the comment related to the component. Would it be possible to do the same for props description?

Describe the solution you’d like If I use the markdown syntax in the props comments, I would like to have the description styled accordingly in the PropsTable in the Docs tab.

Describe alternatives you’ve considered Not styling it? 😉

Are you able to assist bring the feature to reality? no

Additional context Here is an example of comment that would be nice once styled:

/**
 * The type of the date picker:
 *
 * * `simple` - Without calendar dropdown.
 * * `single` - With calendar dropdown and single date.
 * * `range` - With calendar dropdown and a date range.
 */

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:4
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
shilmancommented, Jan 3, 2020

Jiminy cricket!! I just released https://github.com/storybookjs/storybook/releases/tag/v5.3.0-rc.8 containing PR #9307 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

Closing this issue. Please re-open if you think there’s still more to do.

1reaction
shilmancommented, Jan 3, 2020

@iansan5653 you need to add an extra linebreak between the “Possible values are” and the list, per https://github.com/probablyup/markdown-to-jsx/issues/217

As for the paragraph spacing, fixed in #9307. Here’s what it looks like after the tweak:

Addons___Docs___stories_-_Basic_⋅_Storybook
Read more comments on GitHub >

github_iconTop Results From Across the Web

React Markdown: A Thorough Guide With ...
In this article, we'll explore what Markdown and react-markdown are, why to use react-markdown, and how to use them in a React application....
Read more >
ArgsTable - Storybook - JS.ORG
Thousands of teams use it for UI development, testing, and documentation. ... description, Sets a Markdown description for the property.
Read more >
react-docgen-props-table
Start using react-docgen-props-table in your project by running `npm i react-docgen-props-table`. ... NPM JavaScript Style Guide. Example.
Read more >
Basic Syntax | Markdown Guide
The number of number signs you use should correspond to the heading level. ... I think I'll use it to format all of...
Read more >
Documenting design systems with Storybook Docs
CSF is a standard format based on ES6 modules used to define stories and ... are available, the props table will generate automatically:...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found