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

Displaying docs inside the storybook #150

Closed
sakulstra opened this issue Apr 26, 2016 · 3 comments
Closed

Displaying docs inside the storybook #150

sakulstra opened this issue Apr 26, 2016 · 3 comments

Comments

@sakulstra
Copy link

sakulstra commented Apr 26, 2016

At the moment the only way to display docs is the use of:

storiesOf('Main story', module)
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)

This is insufficient for most our components...

In our use case it would be nice if we:

  1. could add some more description (like an optional description tag for the story)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. or even better somehow reads the jsdocs in the js files and displays them above the component examples:
/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */

I think this is somehow related to #56 but not quite the same.

Regards,
Lukas

@arunoda
Copy link
Member

arunoda commented Apr 26, 2016

Yeah. This is great.
If we need the file system manually, that'll be bit harder and over complicated.
But, I think pushing this with the story makes sense.

We are also looking something for this with notes. Basically, with that we have another Tab on the bottom called "Notes".

@kevinSuttle
Copy link
Contributor

I'd prefer a .md file in the component folder, rendered below or beside.

@thani-sh
Copy link
Contributor

Fixed with this addon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants