create-react-styleguide
Advanced tools
Changelog
4.0.0 (2019-04-05)
styleguidist
folder into src
(clean up referenced paths)
include
path for the styleguidist
folder.styleguides
configuration option from crs.config.js
to styleguide.config.js
, and delete the crs.config.js
file
crs.config.js
has been removed in favor of API options on createStyleguideConfig
.STYLEGUIDE.md
to a docs
folder at the root of the project and add sections
configuration to styleguide.config.js
STYLEGUIDE.md
was a little too magical. 4.x now supports your own sections
configuration in styleguide.config.js
, so we should leverage React Styleguidist customization options directly. Read more about sections
configuration here: https://react-styleguidist.js.org/docs/components.html#sections"STYLEGUIDE.md"
from the files
array of package.json
and add "docs"
and "styleguide.config.js"
docs
folder and styleguide.config.js
in order to be linked in other librariessetupFilesAfterEnv: ['<rootDir>/jest.setup.js']
to your jest.config.js
jest.setup.js
file is not a built-in feature of jest, and was a little too magical. If you want to continue to use this convention, you can add the configuration to your own config.babel-preset-zillow
to latest
and remove any configuration for babel-plugin-styled-components
babel-preset-zillow
now includes babel-plugin-styled-components
by default.createJestConfig
now accepts a config object as its only argument which will be shallowly merged with its own config (657a347)createStyleguideConfig
now supports custom sections (c306725)9.0.4
due to the following issue: https://github.com/styleguidist/react-styleguidist/issues/1321.crs.config.js
has been removed in favor of passing options directly to createStyleguideConfig
.
createStyleguideConfig
now takes two params, the first is a config object that will be shallowly merged,
the second is an options object that takes the old styleguides
option for the removed crs.config.js
.
A few other options have been added for customizing how sections are displayed, and this also works with
the DEBUG=true
environmental variable.<a name="3.1.1"></a>