-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implemented JSDocs to Storybook config files.
- Loading branch information
Showing
4 changed files
with
55 additions
and
9 deletions.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,32 @@ | ||
| /**Defines the theme for the documentation */ | ||
| import { create } from '@storybook/theming'; | ||
|
|
||
| export default create({ | ||
| /** | ||
| * Set the base styling of the theme | ||
| * @type {string}*/ | ||
| base: 'light', | ||
| /** | ||
| * The title of the documentation | ||
| * @type {string} | ||
| * @example webqueue2 Style Guide | ||
| * @default <app name from package.json> + Front End Docs | ||
| */ | ||
| brandTitle: 'webqueue2 Front End Docs', | ||
| /** | ||
| * The URL for the website associated with the documentation. | ||
| * @type {string} | ||
| */ | ||
| brandUrl: 'https://engineering.purdue.edu/webqueue/webqueue2/build', | ||
| /** | ||
| * The the brand icon used in the Storybook sidebar. Can use any common image formats | ||
| * @type {string} | ||
| */ | ||
| brandImage: 'https://github.itap.purdue.edu/ECN/webqueue2-frontend/blob/master/public/logo192.png?raw=true', | ||
| /** | ||
| * Set the background of the UI. | ||
| * @type {string} | ||
| * @default 'white' | ||
| */ | ||
| appBg: 'white' | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,11 @@ | ||
| /**Sets the theme for the Storybook UI */ | ||
| import { addons } from '@storybook/addons'; | ||
| import DocsTheme from './DocsTheme'; | ||
|
|
||
| addons.setConfig({ | ||
| /** | ||
| * The the brand icon used in the Storybook sidebar. Can use any common image formats | ||
| * @type {Object} | ||
| */ | ||
| theme: DocsTheme, | ||
| }); | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters