Skip to content

feat(storybook): add project #2054

@MFarabi619

Description

@MFarabi619

What problem will this feature address?

Docs projects have become a staple in modern monorepos, and continue to have a growing focus on outstanding UI aesthetics.

A current pain point with the UI components documentation experience in Fumadocs is the ability to quickly experiment with and view various states of the components.

Image

Describe the solution you'd like

I've already shipped storybooks containing Fumadocs UI components to production, here's an example.

Image

The ability to quickly change the state of a component and see the code has been an enormous boost to developer experience. It makes the components self-documenting, and eases onboarding greatly to open-source project by lowering the 'finding UI components' curve in the codebase.

Image

I was an early adopter of Fumadocs, and realized its potential very quickly. Here's one of my early projects where I made the attempt to bring this vision together.

Image

Describe alternatives you've considered

The following alternatives exist...

Histoire StoryLite Astrobook React Cosmos
Image Image Image Image

and can be added as examples in the future as well. The goal would ideally be to leverage the Component Story Format - CSF as much as possible to avoid the maintenance burden.

Image

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions