Documentation

Document your library

The template has Storybook configuration to handle documentation and examples.

yarn start:docs # starts Storybook in development mode, http://localhost:6006/
yarn build:docs # builds Storybook pages to `storybook-dist` directory

Write

To document component or module, simply create story file as CSF story .stories.tsx or MDX format .mdx extension, more info here.

Config

Storybook config files are stored in .storybook directory.

Deploy

After package is published, you can build and host documentation at GitHub Pages or Netlify, using this manual.