Code Monkey home page Code Monkey logo

Comments (2)

JReinhold avatar JReinhold commented on July 20, 2024 2

Parsing JSDoc comments from meta or stories is currently not supported - it would be a good feature request though if you want to make one.

There's a workaround where you specify the (markdown) content at parameters.docs.description.story|component as documented here: https://storybook.js.org/docs/vue/api/doc-block-description#writing-descriptions

It could look something like this:

<script context='module'>
  import Button from './Button.svelte';

  export const meta = {
    title: 'Button',
    component: Button,
    tags: ['autodocs'],
	parameters: {
      docs: {
        description: {
          component: "your component description here" // 👈👈👈👈👈
        }
      }
    }
  }
</script>

<Template let:args>
  <Button {...args}>
    Click me
  </Button>
</Template>

<Story name="Default" parameters={{ docs: { description: {story: "your story-specific description here"} } }}/>

See it in action here: https://stackblitz.com/edit/github-7v75vw?file=src%2Fstories%2FButton.stories.svelte

from addon-svelte-csf.

yustarandomname avatar yustarandomname commented on July 20, 2024

Validated that this works. Thank you

from addon-svelte-csf.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.