Styleguide generation for nwayo
$ npm install @absolunet/nwayo-extension-styleguide
$ nwayo run styleguide:build
extensions:
'@absolunet/styleguide':
enabled: true
options:
main: # ID
name: My wonderful site # Display name
bundle: site # Bundle to base everything from
output: ../pub/styleguide # Output path
icons-component: site # Which component to use for iconography
scripts-collections: # List of scripts collections to use
- dependencies-head-sync
- dependencies
- main
styles-collections: # List of styles collections to use
- main
sections: # Ordered list of components to crawl for styleguide files
- name: General
component: site
- name: Home widgets
component: widget
divider: true
blog: # Second styleguide [...]
name: My wonderful blog
# [...]
- Under
[...]/nwayo/[COMPONENT]/extensions/styleguide/
- A JsRender template of your styleguide for this component
Styleguide intro
String
Title of the intro block
Whole styleguide content wrapper
String
Additional custom class
Section title (level 1)
Section subtitle (level 2)
Section sub-subtitle (level 3)
Content box
Boolean
If the box has a border
String
Predefined style (dark
)
String
Additional custom class
Content box cell
Boolean
If the box should have gutter spacing
Number
Number of cell per row (2 to 6)
Color palette item
String
Hexadecimal color code
String
Readable name
Font item
String
Readable name
String
font-family css property
String
font-weight css property
String
font-style css property
Get item from konstan
String
Dot-notation key
MIT © Absolunet