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.

[storybook] How about @storybook/addon-docs?

See original GitHub issue

Please make sure you have read the submission guidelines before posting an issue

Prerequisites

Please answer the following questions for yourself before submitting an issue. YOU MAY DELETE THE PREREQUISITES SECTION.

  • I am running the latest version
  • I checked the documentation and found no answer
  • I checked to make sure that this issue has not already been filed
  • I’m reporting the issue to the correct repository (not related to Angular, AngularCLI or any dependency)

Expected Behavior

@nrwl/storybook includes @storybook/addon-docs https://github.com/storybookjs/storybook/tree/master/addons/docs https://www.npmjs.com/package/@storybook/addon-docs

Today, I tried updating to 8.8.0. It’s awesome! I especially excited about supporting Storybook.

Btw, @storybook/addon-docs is good. Because it allows to write documents in mdx. So, I’d like to contain @storybook/addon-docs in @nrwl/storybook. What do you think about this?

I set up @storybook/addon-docs by myself in this repo. Check: https://github.com/tyankatsu0105/sandbox-nx-storybook

Current Behavior

Failure Information (for bugs)

Steps to Reproduce

Context

Failure Logs

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

4reactions
mbriggscommented, Nov 22, 2019

Thank you for your suggestion 😃 We are somewhat hesitant about adding addons by default (beyond knobs), simply because they are almost by definition things that not everyone will use. That being said, something we will do is add some documentation on how to update the configuration for a library or a whole repo to make it easier for people to add them themselves.

0reactions
dobromyslovcommented, Oct 14, 2020

@himanshu803 you may use Storybook Docs addon with Angular with some pipes&tape as explained in the documentation: https://github.com/storybookjs/storybook/blob/HEAD/addons/docs/angular/README.md

For NX you may use compodoc plugin https://github.com/twittwer/nx-tools/tree/master/libs/compodoc#readme

But I can’t figure out how to automatically refresh compodoc and Storybook Docs on changes.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Docs Addon | Storybook: Frontend workshop for UI development
Storybook Docs transforms your Storybook stories into world-class component documentation. DocsPage. Out of the box, all your stories get a DocsPage .
Read more >
@storybook/addon-docs examples - CodeSandbox
Learn how to use @storybook/addon-docs by viewing and forking @storybook/addon-docs example apps on CodeSandbox.
Read more >
Top 5 @storybook/addon-docs Code Examples - Snyk
Learn more about how to use @storybook/addon-docs, based on @storybook/addon-docs code examples created from the most popular ways it is used in public ......
Read more >
Documenting design systems with Storybook Docs
Doc Blocks are the key components to writing docs. Blocks can be accessed by doing named imports from @storybook/addon-docs/blocks
Read more >
@storybook/addon-docs | Yarn - Package Manager
@storybook/addon-docs. owner storybookjs14.3mMIT6.5.15TS vulns 29 vulnerabilities. Document component usage and properties in Markdown.
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