forked from styleguidist/react-styleguidist
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit 0085b38
committed
Changelog: 🚀
👋 **[Support Styleguidist](https://opencollective.com/styleguidist) on Open Collective** 👋
## Breaking changes
### Node 6 is the lowest supported version
Styleguidist doesn’t support Node 4 anymore.
(styleguidist#744 styleguidist#839 by @kohgpat)
### New format of template option
We’re now using [mini-html-webpack-plugin](https://github.com/styleguidist/mini-html-webpack-plugin) and [@vxna/mini-html-webpack-template](https://github.com/vxna/mini-html-webpack-template) instead of [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin).
This will make things like [adding a favicon](https://react-styleguidist.js.org/docs/cookbook#how-to-add-a-favicon) or fonts from [Google Fonts](https://react-styleguidist.js.org/docs/cookbook#how-to-add-fonts-from-google-fonts) much easier.
If you’re using a custom HTML template, you need to update your style guide config.
```js
// 6.x
module.exports = {
template: './styleguie/template.html'
}
// 7.x
module.exports = {
template: {
// This is just an example, there are many more available options
favicon: 'https://assets-cdn.github.com/favicon.ico'
}
}
```
See more [in the docs](https://react-styleguidist.js.org/docs/configuration#template).
(styleguidist#896 styleguidist#907 by @sapegin)
### Changed Node API
`server` method now returns an object containing a webpack `Compiler` instance and the Styleguidist server, see examples [in the docs](https://react-styleguidist.js.org/docs/api.html#servercallback).
(styleguidist#828 by @cmswalker)
## New features
### Webpack 4 support
Webpack 3 is still supported too.
(styleguidist#857 by @kontrollanten, styleguidist#900 styleguidist#901 by @rubenmoya)
### Examples are wrapped in React.Fragment
You don’t need to wrap multiple JSX tags in a div anymore.
```jsx
// 6.x
<div>
<Button primary>Primary button</Button>
<Button secondary>Secondary button</Button>
</div>
// 7.x
<Button primary>Primary button</Button>
<Button secondary>Secondary button</Button>
```
(styleguidist#840 styleguidist#842 by @tizmagik)
## Bug fixes
* `components` option should accept arrays.
* Do not convert URLs in Markdown to auto links (styleguidist#793).
* Improved accessibility (styleguidist#893 by @gergely-nagy).
---
❤️ Huge thanks to @okonet to help with this release, [CI](styleguidist#904) and [docs](styleguidist#905) improvements.️ ❤️1 parent 49c4ec8 commit 0085b38Copy full SHA for 0085b38
File tree
Expand file treeCollapse file tree
0 file changed
+0
-0
lines changedFilter options
Expand file treeCollapse file tree
0 file changed
+0
-0
lines changed
0 commit comments