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

Addon-docs: Clean up description configuration #11441

Closed
shilman opened this issue Jul 7, 2020 · 1 comment
Closed

Addon-docs: Clean up description configuration #11441

shilman opened this issue Jul 7, 2020 · 1 comment

Comments

@shilman
Copy link
Member

shilman commented Jul 7, 2020

Description block should be parameter-configurable for frameworks that don't support auto-extraction. And we have good patterns for that now.

Proposal

export default {
  title: 'CustomDescription'
  parameters: {
    docs: { description: { component: 'some component _markdown_' } },
  }
};

export const WithStoryDescription = Template.bind({});
WithStoryDescription.parameters = {
  docs: { description: { story: 'some story **markdown**' } },
};
@shilman shilman changed the title Addon-docs: Sanitize description parameters Addon-docs: Clean up description configuration Jul 7, 2020
@shilman shilman added this to the 6.0 docs milestone Jul 27, 2020
@shilman shilman self-assigned this Jul 27, 2020
@shilman shilman modified the milestones: 6.0 docs, 6.0.0 Jul 30, 2020
@shilman
Copy link
Member Author

shilman commented Aug 2, 2020

Yippee!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.0.0-rc.22 containing PR #11761 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.

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

1 participant