Skip to content

Commit 53eef5f

Browse files
authored
Merge pull request #1214 from mfranzke/improvement-docs-config-theme-options
docs(config-theme): enhanced related to current implementation
2 parents b0a84f4 + 2acd9d3 commit 53eef5f

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

packages/docs/src/docs/advanced-config-options.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,19 +225,38 @@ These template and page patterns would still be accessible via navigation.
225225

226226
### theme
227227

228-
Sets the theme options for the styleguide. There are three options: 'color', 'density', and 'layout'.
228+
Sets the theme options for the styleguide. There are five options:
229+
* `"color"`
230+
* `"density"`
231+
* `"layout"`
232+
* `"noViewAll"` (optional)
233+
* `"logo"` (optional)
229234

230235
Available values are:
231236

232237
```javascript
233238
"theme" : {
234239
"color" : "dark" | "light",
235240
"density" : "compact" | "cozy" | "comfortable",
236-
"layout" : "horizontal" | "vertical"
241+
"layout" : "horizontal" | "vertical",
242+
"noViewAll" : true | false,
243+
"logo": {
244+
"text": "Pattern Lab",
245+
"altText": "Pattern Lab Logo",
246+
"url": "/",
247+
"srcLight": "styleguide/images/pattern-lab-logo--on-light.svg",
248+
"srcDark": "styleguide/images/pattern-lab-logo--on-dark.svg",
249+
"width": "187",
250+
"height": "185"
251+
}
237252
}
238253
```
239254

240-
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.
255+
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"`.
256+
257+
`"noViewAll"` provides the possibility to hide the "View All" pages and links within the navigation.
258+
259+
And `"logo"` lets you finetune the different aspects of the logo displayed on the left top corner of the styleguide.
241260

242261
**default**:
243262

0 commit comments

Comments
 (0)