Skip to content

Commit

Permalink
Get started
Browse files Browse the repository at this point in the history
  • Loading branch information
cdedreuille committed Jun 13, 2024
1 parent 3ee7e62 commit f15f059
Show file tree
Hide file tree
Showing 8 changed files with 33 additions and 6 deletions.
5 changes: 4 additions & 1 deletion docs/get-started/browse-stories.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: 'Browse Stories'
title: Browse Stories
hideRendererSelector: true
sidebar:
order: 5
title: Browse stories
---

Last chapter, we learned that stories correspond with discrete component states. This chapter demonstrates how to use Storybook as a workshop for building components.
Expand Down
5 changes: 4 additions & 1 deletion docs/get-started/conclusion.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: 'Conclusion'
title: Conclusion
hideRendererSelector: true
sidebar:
order: 7
title: Conclusion
---

Congratulations! You learned the basics. Storybook is the most popular tool for UI component development and documentation. You’ll be able to transfer these skills to thousands of companies that use Storybook to build UIs including GitHub, Airbnb, and Stripe.
Expand Down
3 changes: 3 additions & 0 deletions docs/get-started/frameworks/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Frameworks
sidebar:
order: 3
title: Frameworks
---

<HomeRenderers />
6 changes: 6 additions & 0 deletions docs/get-started/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Get started with Storybook
sidebar:
order: 1
title: Get Started
---
5 changes: 4 additions & 1 deletion docs/get-started/install.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: 'Install Storybook'
title: Install Storybook
sidebar:
order: 2
title: Install
---

Use the Storybook CLI to install it in a single command. Run this inside your project’s root directory:
Expand Down
5 changes: 4 additions & 1 deletion docs/get-started/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: 'Setup Storybook'
title: Setup Storybook
sidebar:
order: 6
title: Setup
---

Now that you’ve learned what stories are and how to browse them, let’s demo working on one of your components.
Expand Down
5 changes: 4 additions & 1 deletion docs/get-started/whats-a-story.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: "What's a story?"
title: What's a story?
sidebar:
order: 4
title: What's a story?
---

A story captures the rendered state of a UI component. Developers write multiple stories per component that describe all the “interesting” states a component can support.
Expand Down
5 changes: 4 additions & 1 deletion docs/get-started/why-storybook.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: 'Why Storybook?'
title: Why Storybook?
sidebar:
order: 1
title: Why Storybook?
---

## The problem
Expand Down

0 comments on commit f15f059

Please sign in to comment.