Remove (required) from headings

- Removed to ensure heading anchor links are stable over time - Consistently display required properties throughout API references
storybookjs · Jun 21, 2023 · 320aed5 · 320aed5
1 parent dde3e33
commit 320aed5
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 13 deletions.
diff --git a/docs/api/doc-block-colorpalette.md b/docs/api/doc-block-colorpalette.md
@@ -66,19 +66,25 @@ import { ColorItem } from '@storybook/blocks';
 
 `ColorItem` is configured with the following props:
 
-### `colors` (required)
+### `colors`
+
+(**Required**)
 
 Type: `string[] | { [key: string]: string }`
 
 Provides the list of colors to be displayed. Accepts any valid CSS color format (hex, RGB, HSL, etc.). When an object is provided, the keys will be displayed above the values.
 
-### `subtitle` (required)
+### `subtitle`
+
+(**Required**)
 
 Type: `string`
 
 Provides an additional description of the color.
 
-### `title` (required)
+### `title`
+
+(**Required**)
 
 Type: `string`
 

diff --git a/docs/api/doc-block-icongallery.md b/docs/api/doc-block-icongallery.md
@@ -75,7 +75,9 @@ import { IconItem } from '@storybook/blocks';
 
 `IconItem` is configured with the following props:
 
-### `name` (required)
+### `name`
+
+(**Required**)
 
 Type: `string`
 

diff --git a/docs/api/doc-block-useof.md b/docs/api/doc-block-useof.md
@@ -67,7 +67,9 @@ useOf = (
 
 ## Parameters
 
-### `moduleExportOrType` (required)
+### `moduleExportOrType`
+
+(**Required**)
 
 Type: `ModuleExport | 'story' | 'meta' | 'component'`
 

diff --git a/docs/api/main-config-framework.md b/docs/api/main-config-framework.md
@@ -2,12 +2,12 @@
 title: 'framework'
 ---
 
+(**Required**)
+
 Parent: [main.js|ts configuration](./main-config.md)
 
 Type: `FrameworkName | { name: FrameworkName; options?: FrameworkOptions }`
 
-Required: `true`
-
 Configures Storybook based on a set of [framework-specific](../configure/frameworks.md) settings.
 
 <!-- prettier-ignore-start -->

diff --git a/docs/api/main-config-stories.md b/docs/api/main-config-stories.md
@@ -2,6 +2,8 @@
 title: 'stories'
 ---
 
+(**Required**)
+
 Parent: [main.js|ts configuration](./main-config.md)
 
 Type:
@@ -11,8 +13,6 @@ Type:
 | async (list: (string | StoriesSpecifier)[]) => (string | StoriesSpecifier)[]
 ```
 
-Required: `true`
-
 Configures Storybook to load stories from the specified locations. The intention is for you to colocate a story file along with the component it documents:
 
 ```
@@ -91,9 +91,9 @@ Type:
 
 #### `StoriesSpecifier.directory`
 
-Type: `string`
+(**Required**)
 
-Required: `true`
+Type: `string`
 
 Where to start looking for story files, relative to the root of your project.
 

diff --git a/docs/api/main-config.md b/docs/api/main-config.md
@@ -25,8 +25,8 @@ A typical Storybook configuration file looks like this:
 
 An object to configure Storybook containing the following properties:
 
-- [`framework`](./main-config-framework.md) (required)
-- [`stories`](./main-config-stories.md) (required)
+- [`framework`](./main-config-framework.md) (Required)
+- [`stories`](./main-config-stories.md) (Required)
 - [`addons`](./main-config-addons.md)
 - [`babel`](./main-config-babel.md)
 - [`babelDefault`](./main-config-babel-default.md)