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.

Documentation - DocsPage - Add additional explanation of how to replace DocsPage

See original GitHub issue

Is your feature request related to a problem? Please describe. I would like to override the docsPage with my own documentation. The current DocsPage documentation details how to override the docsPage with null but does not suggest how one might replace it with something else (specifically MDX docs). However, there is a recipe for this elsewhere.

Describe the solution you’d like Ideally, the Replacing DocsPage section would be reorganized by the three options given (null, MDX, custom component), and snippets would be given for each.

Describe alternatives you’ve considered As an alternative, it would still be helpful to link to the recipe.

Are you able to assist bring the feature to reality? I can reorganize the section and write the snippets for MDX. I don’t know about the custom component part, so I wouldn’t be able to write that part without some help.

Additional context Add any other context or screenshots about the feature request here.

Issue Analytics

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

github_iconTop GitHub Comments

1reaction
jonniebigodescommented, Jul 13, 2021

@novellac closing this issue as the documentation was already updated by a recent pull request that was pushed by me. Feel free to ping me here if the documentation can be improved in any other way and we’ll go from there. Sounds good?

Stay safe!

0reactions
shilmancommented, Apr 30, 2021

@sethbro Sounds like maybe some kind of yarn/npm hoisting issue. @storybook/addon-essentials is just a macro that adds an un-configured @storybook/addon-docs

Read more comments on GitHub >

github_iconTop Results From Across the Web

DocsPage - Storybook - JS.ORG
When you install Storybook Docs, DocsPage is the zero-config default ... the story file's default export to extract the component's description and props....
Read more >
storybook/addon-docs - npm
DocsPage pulls information from your stories, components, source code, and story metadata to construct a sensible, zero-config default. Click on ...
Read more >
Custom documentation pages for storybookjs - Atanas Stoyanov
Step by step guide. Getting started. install the addon: yarn add @component-controls/storybook-custom-docs. in ...
Read more >
Replacing Storybook's DocsPage with my .mdx file
You can actually link files to these, if you want the description ... You actually create documentation for both Canvas and Docs using...
Read more >
Compare DocsPage and MDX syntax in Storybook with example
MDX. MDX gives you lot of freedom to create free-form pages for each component, where we can simultaneously document components and write stories...
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