Skip to content

Commit

Permalink
Merge pull request #28365 from storybookjs/update-api-index
Browse files Browse the repository at this point in the history
Docs: Update docs API index
  • Loading branch information
kylegach authored Jun 27, 2024
2 parents 64b3d40 + dbe9955 commit 4e2ddb6
Showing 1 changed file with 61 additions and 61 deletions.
122 changes: 61 additions & 61 deletions docs/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,112 +17,112 @@ An overview of all available API references for Storybook.

## Configuration

<table>
<Table>
<thead>
<tr>
<th scope="col" width="33%">Name</th>
<th scope="col">Description</th>
</tr>
<Tr>
<Th scope="col" width="33%">Name</Th>
<Th scope="col">Description</Th>
</Tr>
</thead>

<tbody>
<tr>
<td><a href="../api/main-config"><code>main.js|ts</code></a></td>
<Tr>
<Td><A href="./api/main-config/main-config"><code>main.js|ts</code></A></Td>

<td>
<Td>
Storybook's primary configuration file, which specifies your Storybook project's behavior,
including the location of your stories, the addons you use, feature flags and other
project-specific settings.
</td>
</tr>
</Td>
</Tr>

<tr>
<td><a href="../configure/#configure-story-rendering"><code>preview.js|jsx|ts|tsx</code></a></td>
<Tr>
<Td><A href="./configure/#configure-story-rendering"><code>preview.js|jsx|ts|tsx</code></A></Td>

<td>
<Td>
This configuration file controls the way stories are rendered. You can also use it to run
code that applies to all stories.
</td>
</tr>
</Td>
</Tr>

<tr>
<td><a href="../configure/#configure-storybooks-ui"><code>manager.js|ts</code></a></td>
<Tr>
<Td><A href="./configure/#configure-storybooks-ui"><code>manager.js|ts</code></A></Td>

<td>
<Td>
This configuration file controls the behavior of Storybook's UI, the manager.
</td>
</tr>
</Td>
</Tr>

<tr>
<td><a href="../api/cli-options">CLI</a></td>
<Tr>
<Td><A href="./api/cli-options">CLI</A></Td>

<td>
<Td>
Storybook is a CLI tool. You can start Storybook in development mode or build a static
version of your Storybook.
</td>
</tr>
</Td>
</Tr>
</tbody>
</table>
</Table>

## Stories

<table>
<Table>
<thead>
<tr>
<th scope="col" width="33%">Name</th>
<th scope="col">Description</th>
</tr>
<Tr>
<Th scope="col" width="33%">Name</Th>
<Th scope="col">Description</Th>
</Tr>
</thead>

<tbody>
<tr>
<td><a href="../api/csf">CSF</a></td>
<Tr>
<Td><A href="./api/csf">CSF</A></Td>

<td>
<Td>
Component Story Format (CSF) is the API for writing stories. It's an
<a href="https://github.com/ComponentDriven/csf">open standard</a> based on ES6 modules that
is portable beyond Storybook.
</td>
</tr>
is porTable beyond Storybook.
</Td>
</Tr>

<tr>
<td><a href="../api/arg-types">ArgTypes</a></td>
<Tr>
<Td><A href="./api/arg-types">ArgTypes</A></Td>

<td>
ArgTypes specify the behavior of <a href="../writing-stories/args">args</a>. By specifying
<Td>
ArgTypes specify the behavior of <a href="./writing-stories/args">args</a>. By specifying
the type of an arg, you constrain the values that it can accept and provide information
about args that are not explicitly set.
</td>
</tr>
</Td>
</Tr>

<tr>
<td><a href="../api/parameters">Parameters</a></td>
<Tr>
<Td><A href="./api/parameters">Parameters</A></Td>

<td>
Parameters are static metadata used to configure your <a href="../get-started/whats-a-story.mdx">stories</a> <a href="../addons/index.mdx">addons</a> in Storybook. They are specified at the story, meta (component), project (global) levels.
</td>
</tr>
<Td>
Parameters are static metadata used to configure your <a href="./get-started/whats-a-story">stories</a> <a href="./addons">addons</a> in Storybook. They are specified at the story, meta (component), project (global) levels.
</Td>
</Tr>
</tbody>
</table>
</Table>

## Docs

<table>
<Table>
<thead>
<tr>
<th scope="col" width="33%">Name</th>
<th scope="col">Description</th>
</tr>
<Tr>
<Th scope="col" width="33%">Name</Th>
<Th scope="col">Description</Th>
</Tr>
</thead>

<tbody>
<tr>
<td><a href="../writing-docs/doc-blocks/#available-blocks">Doc blocks</a></td>
<Tr>
<Td><A href="./writing-docs/doc-blocks/#available-blocks">Doc blocks</A></Td>

<td>
<Td>
Storybook offers several doc blocks to help document your components and other aspects of
your project.
</td>
</tr>
</Td>
</Tr>
</tbody>
</table>
</Table>

0 comments on commit 4e2ddb6

Please sign in to comment.