Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@storybook/addon-docs

Package Overview
Dependencies
Maintainers
12
Versions
1771
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storybook/addon-docs

Document component usage and properties in Markdown

  • 8.5.0-beta.4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4.3M
decreased by-23.71%
Maintainers
12
Weekly downloads
 
Created

What is @storybook/addon-docs?

The @storybook/addon-docs package is a Storybook addon that allows developers to write documentation alongside their stories. It uses MDX (Markdown with JSX) to let you document components in a rich, interactive way. It can generate documentation automatically based on your stories and supports a wide range of component frameworks.

What are @storybook/addon-docs's main functionalities?

MDX Documentation

Allows writing documentation using MDX, which can include both Markdown and JSX. You can define metadata, write narrative documentation, and showcase live examples and prop tables.

import { Meta, Story, ArgsTable, Canvas } from '@storybook/addon-docs/blocks';

<Meta title='MyComponent' />

# MyComponent

This is a **custom documentation** for `MyComponent`.

<Canvas>
  <Story name='Basic' args={{ label: 'Hello World' }}>
    {args => <MyComponent {...args} />}
  </Story>
</Canvas>

<ArgsTable story='Basic' />

Automatic Props Table

Generates a table of the component's props automatically. This table includes the prop names, types, default values, and descriptions if they are specified in the component's propTypes or TypeScript definitions.

import { Meta, Story, ArgsTable } from '@storybook/addon-docs/blocks';

<Meta title='MyComponent' />

<Story name='Basic'>
  <MyComponent />
</Story>

<ArgsTable of={MyComponent} />

Embedding Stories

Allows embedding live Storybook stories within the documentation. This provides an interactive example of the component in use.

import { Meta, Story } from '@storybook/addon-docs/blocks';

<Meta title='MyComponent' />

<Story name='Basic'>
  <MyComponent />
</Story>

Other packages similar to @storybook/addon-docs

Keywords

FAQs

Package last updated on 20 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc