styleguidist/react-styleguidist 3.0.0

on GitHub

Breaking changes

Improved state

Previously setState in examples was causing component rerender which was braking animation and other things.

Default state definition was changed. Instead of:

'count' in state || setState({ count : 1})

You should do:

initialState = { count: 1 };

(#51, #134 by @saschatimme)

Collapsible code examples

Now code examples are collapsed by default, you can change it by showCode option.

(#86, #150 by @tizmagik)

New features

Basic isolated links implementation

Now you can open any component in a separate page:

The UI requires more work, any help is appreciated.

Other changes and fixes

• Allow markdown ```example to render interactive example (#151 by @uipoet).
• Very basic HTML support in examples (#141).
• Update CodeMirror, remove custom JSX mode (#19).
• Avoid React error about void elements with children, fixes images in Markdown (#140).