Skip to content

(api help) "no readme found" for story exported as object without storiesOf #231

@Mazuh

Description

@Mazuh

I'm mostly new to storybook and this addon, and I'm confused by reading the instructions for inserting this addon without a having storiesOf explicitly coded.

I'm used to export an object with the data I need, that's how the boilerplate I downloaded instructed and that's how it's working... except for this readme addon config. It just keeps saying "no readme found".

import IconsMd from '../instructions/Icons.md';

I tried

export default {
  title: 'Icons',
  parameters: {
    options: {
      panelPosition: 'right',
      readme: {
        content: `
<!-- STORY -->
<!-- PROPS -->
`,
        sidebar: IconsMd,
      },
    },
  },
};

and

export default {
  title: 'Icons',
  parameters: {
    options: {
      panelPosition: 'right',
    },
    readme: {
      content: `
<!-- STORY -->
<!-- PROPS -->
`,
      sidebar: IconsMd,
    },
  },
};

The panel position thing worked.. but I believe that's only me being dumb about the API for inserting the readme. Could someone help me?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions