Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(config-theme): enhanced related to current implementation #1214

Merged
merged 1 commit into from
Jun 28, 2020
Merged

docs(config-theme): enhanced related to current implementation #1214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions packages/docs/src/docs/advanced-config-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,19 +225,38 @@ These template and page patterns would still be accessible via navigation.

### theme

Sets the theme options for the styleguide. There are three options: 'color', 'density', and 'layout'.
Sets the theme options for the styleguide. There are five options:
* `"color"`
* `"density"`
* `"layout"`
* `"noViewAll"` (optional)
* `"logo"` (optional)

Available values are:

```javascript
"theme" : {
"color" : "dark" | "light",
"density" : "compact" | "cozy" | "comfortable",
"layout" : "horizontal" | "vertical"
"layout" : "horizontal" | "vertical",
"noViewAll" : true | false,
"logo": {
"text": "Pattern Lab",
"altText": "Pattern Lab Logo",
"url": "/",
"srcLight": "styleguide/images/pattern-lab-logo--on-light.svg",
"srcDark": "styleguide/images/pattern-lab-logo--on-dark.svg",
"width": "187",
"height": "185"
}
}
```

See the [initial release notes](https://github.com/pattern-lab/styleguidekit-assets-default/releases/tag/v4.0.0-alpha.2) for the theme feature for example output.
See the [initial release notes](https://github.com/pattern-lab/styleguidekit-assets-default/releases/tag/v4.0.0-alpha.2) for the theme feature for example output on `"color"`, `'density"` and `"layout"`.

`"noViewAll"` provides the possibility to hide the "View All" pages and links within the navigation.

And `"logo"` lets you finetune the different aspects of the logo displayed on the left top corner of the styleguide.

**default**:

Expand Down