@storybook/addon-docs
- Version 8.6.6
- Published
- 2.25 MB
- 7 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
Functions
function _default
_default: () => core_dist_types.ProjectAnnotations<core_dist_types.Renderer>;
Classes
class DocsRenderer
class DocsRenderer<TRenderer extends Renderer> {}
constructor
constructor();
property render
render: DocsRenderFunction<TRenderer>;
property unmount
unmount: (element: HTMLElement) => void;
Interfaces
interface DocsParameters
interface DocsParameters {}
property docs
docs?: { /** * The subtitle displayed when shown in docs page * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes */ argTypes?: ArgTypesBlockParameters; /** * Canvas configuration when shown in docs page * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas */ canvas?: CanvasBlockParameters; /** * Controls block configuration * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-controls */ controls?: ControlsBlockParameters; /** * Component/story description when shown in docs page * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-description#writing-descriptions */ description?: DescriptionBlockParameters; /** Remove the addon panel and disable the addon's behavior */ disable?: boolean; /** * Replace the default documentation template used by Storybook with your own * * @see https://storybook.js.org/docs/writing-docs/autodocs#write-a-custom-template */ page?: unknown; /** * Source code configuration when shown in docs page * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source */ source?: SourceBlockParameters; /** * Story configuration * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-story */ story?: StoryBlockParameters; /** * The subtitle displayed when shown in docs page * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-subtitle */ subtitle?: string; /** * The title displayed when shown in docs page * * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-title */ title?: string;};
Docs configuration
See Also
https://storybook.js.org/docs/writing-docs
Package Files (1)
Dependencies (7)
Dev Dependencies (9)
Peer Dependencies (1)
Badge
To add a badge like this oneto 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[](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>
- Updated .
Package analyzed in 4166 ms. - Missing or incorrect documentation? Open an issue for this package.