Logo for jsDocs.io

@storybook/addon-docs

  • Version 9.1.3
  • Published
  • 2.42 MB
  • 7 dependencies
  • MIT license

Install

npm i @storybook/addon-docs
yarn add @storybook/addon-docs
pnpm add @storybook/addon-docs

Overview

Storybook Docs: Document UI components automatically with stories and MDX

Index

Functions

Classes

Interfaces

Functions

function _default

_default: () => storybook_internal_csf.PreviewAddon<DocsTypes>;

    Classes

    class DocsRenderer

    class DocsRenderer<TRenderer extends Renderer> {}

      constructor

      constructor();

        property render

        render: DocsRenderFunction<TRenderer>;

          property unmount

          unmount: (element: HTMLElement) => void;

            Interfaces

            interface DocsTypes

            interface DocsTypes {}

              property parameters

              parameters: DocsParameters;

                Package Files (1)

                Dependencies (7)

                Dev Dependencies (19)

                Peer Dependencies (1)

                Badge

                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@storybook/addon-docs.

                • Markdown
                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@storybook/addon-docs)
                • HTML
                  <a href="https://www.jsdocs.io/package/@storybook/addon-docs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>