Open tuchk4 opened 5 years ago
Or we can use jsdoc or similar tool to generate markdown docs on all sources related to story and automatically render at addons panel.
@lonyele What do you think?
@tuchk4 This looks super cool! How come I couldn't see your mention on my gmail? It's Monday here(weekend is over...), so I'll check this one and #171 over this week(probably coming weekends)
@tuchk4 I maybe can implement this feature as I've understood more about placeholder part of code base while looking at #171. If this feature is implemented and became stable, storybook-readme
can have full power on React components that are used here. I think filtering prop tables can be improved by covering more practical cases such as HOC, Render prop or showing whatever propTables if it is specified.
Sunday is almost over here, I think I can do it in coming week. As I know of, you are busy for 1~2 month and preparing for next release. So maybe I can take a look at it?
Yeah, I would like to start with #171 and then add support of all features described here.
According to #171 Proof of concept implemented at #178 for such story:
## TItle
\```js
const value = state.counter || 0;
<Button
onClick={() => {
setState({
counter: value + 1,
});
}}
>
Hello World {value}
</Button>;
\```
### Footer
We will have:
So it is possible to render prop table, methods table, description right after story and make it configurable.
So maybe I can take a look at it?
This would be perfect 🔥
Also we should think:
The same way as
<!-- PROPS -->
works. Support<!-- DESCRIPTION -->
component's description<!-- METHODS -->
component's methods<!-- DOCS -->
aggregate & description & methods & propsAlso would be nice to automatically generate default readmes