@storybook/addon-docs

  • Version 7.6.17
  • Published
  • 106 kB
  • 19 dependencies
  • MIT license

Install

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

Overview

Document component usage and properties in Markdown

Index

Classes

class DocsRenderer

class DocsRenderer<TRenderer extends Renderer> {}

    constructor

    constructor();

      property render

      render: DocsRenderFunction<TRenderer>;

        property unmount

        unmount: (element: HTMLElement) => void;

          Package Files (1)

          Dependencies (19)

          Dev Dependencies (5)

          Peer Dependencies (2)

          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>