Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Storybook to document components #97

Open
15 tasks
meganesu opened this issue Jan 21, 2023 · 0 comments
Open
15 tasks

Add Storybook to document components #97

meganesu opened this issue Jan 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@meganesu
Copy link
Owner

meganesu commented Jan 21, 2023 •
edited
Loading

Background

As I'm starting to build out more custom components, I want to have a Storybook instance I can use to document the variations and usage.

This will make it easier for me to do a quick visual check of all the different component scenarios when I make changes, to make sure I didn't accidentally break any CSS styles.

Scenarios

  • BrowserWindow
  • CodeBlock
    • With text wrap
    • No language or file tag
    • Language tag only
    • File tag only
    • Code highlighting
      • highlight-line
      • highlight-start and highlight-end
      • highlight-next-line
  • Collapsible
  • InlineCode component:
    • Long inline code snippet that needs to wrap onto a new line (see zsh profile post for examples)
  • IPadScreen
  • MailingListSignupForm
  • YouTubeEmbed

Resources

Storybook Docs
@meganesu meganesu added the documentation Improvements or additions to documentation label Jan 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@meganesu