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: Add docs.description parameter #11761

Merged
merged 1 commit into from
Aug 2, 2020

Conversation

shilman
Copy link
Member

@shilman shilman commented Aug 2, 2020

Issue: #11441

What I did

import { Button } from './Button';

export default {
  title: 'Button',
  parameters: {
    docs: { description: { component: 'some component **markdown**' } }
  }
}

export const Basic = () => <Button />
Basic.parameters = {
  docs: { description: { story: 'some story **markdown**' } }
}

How to test

See updated example in official-storybook

Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shilman shilman merged commit bb68b50 into next Aug 2, 2020
@stof stof deleted the 11441-docs-description-parameter branch May 25, 2022 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants