Update toc format and add some placeholder md files

This commit is contained in:
Tom Coleman 2020-07-09 18:43:11 +10:00
parent 54dc9e7e8d
commit 7fccb22e10
8 changed files with 65 additions and 60 deletions

View File

@ -0,0 +1,3 @@
---
title: 'Browse Stories'
---

View File

@ -0,0 +1,3 @@
---
title: 'Conclusion'
---

View File

@ -0,0 +1,3 @@
---
title: 'Install'
---

View File

@ -0,0 +1,27 @@
---
title: 'Introduction'
---
Storybook is a tool for UI development. It makes development faster and easier by isolating components. This allows you to work on one component at a time. You can develop entire UIs without needing to start up a complex dev stack, force certain data into your database or navigate around your application.
![This is a test image](./test-image.png)
<SS>
Use Storybook to build small atomic components and complex pages in your web application. If it is a UI, you can build it with Storybook.
<SSs>
Storybook helps you document components for reuse and automatically visually test your components to prevent bugs. Extend Storybook with an ecosystem of addons that help you do things like fine tune responsive layouts or verify accessibility.
Storybook integrates with many popular JavaScript UI frameworks and (experimentally) supports server-rendered component frameworks such as Ruby on Rails.
## Learning resources
If you want to learn more about the component-driven approach that Storybook enables, this blog post is a good place to start.
If you want a guided tutorial through building a simple application with Storybook in your framework and language, LearnStorybook has your back.
If you want to just learn the basics and APIs of Storybook, read on!
> > [Get started installing Storybook into your project](./install)

View File

@ -0,0 +1,3 @@
---
title: 'Setup'
---

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 KiB

View File

@ -0,0 +1,3 @@
---
title: "What's a Story"
---

View File

@ -1,62 +1,25 @@
module.exports = {
toc: {
basics: [
'/basics/introduction/',
'/basics/writing-stories/',
'/basics/exporting-storybook/',
'/basics/faq/',
'/basics/live-examples/',
],
guides: [
'/guides/quick-start-guide/',
'/guides/slow-start-guide/',
'/guides/guide-html/',
'/guides/guide-react/',
'/guides/guide-react-native/',
'/guides/guide-vue/',
'/guides/guide-angular/',
'/guides/guide-mithril/',
'/guides/guide-marko/',
'/guides/guide-ember/',
'/guides/guide-riot/',
'/guides/guide-svelte/',
'/guides/guide-preact/',
'/guides/guide-web-components/',
],
configurations: [
'/configurations/overview/',
'/configurations/options-parameter/',
'/configurations/default-config/',
'/configurations/custom-webpack-config/',
'/configurations/custom-babel-config/',
'/configurations/typescript-config/',
'/configurations/add-custom-head-tags/',
'/configurations/add-custom-body/',
'/configurations/serving-static-files/',
'/configurations/env-vars/',
'/configurations/theming/',
'/configurations/composition/',
'/configurations/cli-options/',
'/configurations/standalone-options/',
],
formats: [
'/formats/component-story-format/',
'/formats/storiesof-api/',
'/formats/mdx-syntax/',
],
testing: [
'/testing/react-ui-testing/',
'/testing/structural-testing/',
'/testing/interaction-testing/',
'/testing/automated-visual-testing/',
'/testing/manual-testing/',
],
addons: [
'/addons/introduction/',
'/addons/using-addons/',
'/addons/writing-addons/',
'/addons/api/',
],
presets: ['/presets/introduction/', '/presets/preset-gallery/', '/presets/writing-presets/'],
},
toc: [
{
section: 'Get Started',
prefix: 'get-started',
pages: ['introduction', 'install', 'whats-a-story', 'browse-stories', 'setup', 'conclusion'],
},
{
section: 'Writing Stories',
prefix: 'writing-stories',
pages: [
'introduction',
'args',
'parameters',
'decorators',
'naming-components-and-hierarchy',
],
},
{
section: 'Writing Docs',
prefix: 'writing-docs',
pages: ['introduction', 'docs-page', 'mdx', 'doc-blocks'],
},
],
};