Skip to content

Commit

Permalink
fix: spelling fix
Browse files Browse the repository at this point in the history
  • Loading branch information
@martin-stoyanov
martin-stoyanov committed Feb 15, 2021
1 parent 8dda340 commit d369821
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 17 deletions.
2 changes: 1 addition & 1 deletion core/core/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion core/core/src/configuration.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ export type RunOnlyConfiguration = {
*/
copyright?: string;
/**
* site language, Deault is "en"
* site language, Default is "en"
*/
language?: string;

Expand Down
30 changes: 16 additions & 14 deletions examples/stories/src/tutorial/configuration/runtime.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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 `<meta name="image" content={language} />` |
| `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 => &lt;ThemeProvider>{story()}&lt;/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 `<meta name="image" content={language} />` |
| `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 |
2 changes: 1 addition & 1 deletion examples/stories/src/tutorial/getting-started/ui-customization.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The site meta settings are used both for SEO purposes as page `<meta />` tags an
language: {
type: ControlTypes.TEXT,
value: '',
description: 'Site language, Deault is "en"',
description: 'Site language, Default is "en"',
},
author: {
type: ControlTypes.TEXT,
Expand Down

0 comments on commit d369821

Please sign in to comment.