From d369821c17ee9e208ff240fbeae2aa02fc287028 Mon Sep 17 00:00:00 2001 From: martin-stoyanov Date: Sun, 14 Feb 2021 19:13:31 -0500 Subject: [PATCH] fix: spelling fix --- core/core/README.md | 2 +- core/core/src/configuration.ts | 2 +- .../src/tutorial/configuration/runtime.mdx | 30 ++++++++++--------- .../getting-started/ui-customization.mdx | 2 +- 4 files changed, 19 insertions(+), 17 deletions(-) diff --git a/core/core/README.md b/core/core/README.md index 2400a6f4d..4b8ec8dea 100644 --- a/core/core/README.md +++ b/core/core/README.md @@ -1175,7 +1175,7 @@ _defined in [@component-controls/core/src/configuration.ts](https://github.com/c | `description` | string | site description. Default is "Component controls stories. Write your components documentation with MDX and JSX. Design, develop, test and review in a single site." | | `footer` | [ToolbarConfig](#toolbarconfig) | custom footer items | | `image` | string | link to site image | -| `language` | string | site language, Deault is "en" | +| `language` | string | site language, Default is "en" | | `links` | DetailedHTMLProps<LinkHTMLAttributes<[HTMLLinkElement](#htmllinkelement)>, [HTMLLinkElement](#htmllinkelement)>\[] | meta links for seo header | | `logo` | string \| [ReactNode](#reactnode) | logo for the site - can be a string link to an image, or a react node | | `menu` | [StaticMenuItems](#staticmenuitems) | static menu items, can be used in conjunction with the menu prop on the document provides compatibility with docz | diff --git a/core/core/src/configuration.ts b/core/core/src/configuration.ts index fe73ea390..dbdf5c5dc 100644 --- a/core/core/src/configuration.ts +++ b/core/core/src/configuration.ts @@ -282,7 +282,7 @@ export type RunOnlyConfiguration = { */ copyright?: string; /** - * site language, Deault is "en" + * site language, Default is "en" */ language?: string; diff --git a/examples/stories/src/tutorial/configuration/runtime.mdx b/examples/stories/src/tutorial/configuration/runtime.mdx index 002a8764e..f61f08b54 100644 --- a/examples/stories/src/tutorial/configuration/runtime.mdx +++ b/examples/stories/src/tutorial/configuration/runtime.mdx @@ -5,13 +5,15 @@ order: 2 route: /configuration/runtime/ tags: - configuration -author: atanasster +author: atanasster --- ## File + The run-time configuration file is located in the [configuration-path](/configuration/overview/#configuration-path) folder. This file runs in a **browser** environment and you can use regular javascript or typescript. Possible names for the file are: + - `buildtime.js` - `runtime.js` - `runtime.ts` @@ -22,16 +24,16 @@ Possible names for the file are: ## Configurable Fields -| Name | Type | Description | -| ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `author` | string | author: Default is "@component-controls" | -| `decorators` | [StoryRenderFn]((/tutorial/reference/configuration/#storyrenderfn)\[] | story decorator functions - used to wrap stories. Example: \[story => <ThemeProvider>{story()}</ThemeProvider>] | -| `pages` | [PagesConfiguration]((/tutorial/reference/configuration#pagesconfiguration) | page types configurations | -| `description` | string | site description. Default is "Component controls stories. Write your components documentation with MDX and JSX. Design, develop, test and review in a single site." | -| `copyright` | string | copyright notice displayed in the footer| -| `image` | string | link to site image, used in page meta tag `` | -| `language` | string | site language, Deault is "en" | -| `title` | string | standalone site title. Default is "Component controls" | -| `storySort` | **function** (`a`\*: string, `b`\*: string): number; | story sorting function | -| `theme` | \[key: string]: any | theme-ui theme configuration | -| `toolbar` | [ToolbarConfig](/tutorial/reference/configuration#toolbarconfig) | custom toolbar items +| Name | Type | Description | +| ------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `author` | string | author: Default is "@component-controls" | +| `decorators` | [StoryRenderFn]((/tutorial/reference/configuration/#storyrenderfn)\[] | story decorator functions - used to wrap stories. Example: \[story => <ThemeProvider>{story()}</ThemeProvider>] | +| `pages` | [PagesConfiguration]((/tutorial/reference/configuration#pagesconfiguration) | page types configurations | +| `description` | string | site description. Default is "Component controls stories. Write your components documentation with MDX and JSX. Design, develop, test and review in a single site." | +| `copyright` | string | copyright notice displayed in the footer | +| `image` | string | link to site image, used in page meta tag `` | +| `language` | string | site language, Default is "en" | +| `title` | string | standalone site title. Default is "Component controls" | +| `storySort` | **function** (`a`\*: string, `b`\*: string): number; | story sorting function | +| `theme` | \[key: string]: any | theme-ui theme configuration | +| `toolbar` | [ToolbarConfig](/tutorial/reference/configuration#toolbarconfig) | custom toolbar items | diff --git a/examples/stories/src/tutorial/getting-started/ui-customization.mdx b/examples/stories/src/tutorial/getting-started/ui-customization.mdx index 689802cd1..f1da763fe 100644 --- a/examples/stories/src/tutorial/getting-started/ui-customization.mdx +++ b/examples/stories/src/tutorial/getting-started/ui-customization.mdx @@ -53,7 +53,7 @@ The site meta settings are used both for SEO purposes as page `` tags an language: { type: ControlTypes.TEXT, value: '', - description: 'Site language, Deault is "en"', + description: 'Site language, Default is "en"', }, author: { type: ControlTypes.TEXT,