Skip to content

Adding docs howto create a project storybook with customized VLT theme #864

Description

@acsr

The Storybook in the VLT docs is created from the ".stories.tsx" files in the VLT package:
https://volto-light-theme.readthedocs.io/storybook/?path=/docs/primitives-summary--docs

It does no inbetween explanation how it is created and what the scope of the Storybook is or any hints how to e.g. tweak the mock texts live in the browser (without dev tools) for trying variants out.

Goal of the Howto

Simplify development cycles and improve customer documentation for digital brandbooks etc. by lowering the bar to use existing tooling.

Helpers

You can list the Storybook source files in the volto-light-theme repository like this:

tree -a -P "*.storybook|*.stories.tsx" --matchdirs --prune ./frontend

output:

./frontend
├── .storybook
│   ├── main.js
│   └── preview.jsx
└── packages
    └── volto-light-theme
        └── src
            ├── components
            │   ├── Summary
            │   │   └── Summary.stories.tsx
            │   └── Widgets
            │       └── ColorSwatch.stories.tsx
            ├── primitives
            │   └── Card
            │       └── Card.stories.tsx
            └── stories
                ├── grid.teaser.stories.tsx
                ├── listing.stories.tsx
                └── teaser.stories.tsx

11 directories, 8 files

Purpose

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions