Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: html-webpack-plugin → mini-html-webpack-plugin #907

Merged
merged 6 commits into from
Mar 30, 2018
Merged

Conversation

sapegin
Copy link
Member

@sapegin sapegin commented Mar 29, 2018

  • Implementation
  • Tests
  • Docs

Closes #896

@sapegin sapegin requested a review from okonet March 29, 2018 20:45
@sapegin sapegin added this to the 7.0.0 milestone Mar 29, 2018
Copy link
Member

@okonet okonet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM besides one comment

throw new StyleguidistError(
`${chalk.bold(
'template'
)} config option format was changed, you need to update your config.`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was => has been? And probably a link to docs?

@codecov-io
Copy link

codecov-io commented Mar 30, 2018

Codecov Report

Merging #907 into master will increase coverage by 0.02%.
The diff coverage is 100%.

Impacted Files Coverage Δ
scripts/config.js 96.87% <ø> (ø) ⬆️
scripts/make-webpack-config.js 95.45% <100%> (+0.45%) ⬆️
scripts/schemas/config.js 87.5% <100%> (+1.29%) ⬆️
scripts/utils/error.js 100% <100%> (ø) ⬆️
scripts/utils/sanitizeConfig.js 100% <100%> (ø) ⬆️

@sapegin sapegin merged commit 01509be into master Mar 30, 2018
@sapegin sapegin deleted the minihtmlplugin branch March 30, 2018 15:22
sapegin added a commit that referenced this pull request Mar 31, 2018
👋 **[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.

(#744 #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).

(#896 #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).

(#828 by @cmswalker)

## New features

### Webpack 4 support

Webpack 3 is still supported too.

(#857 by @kontrollanten, #900 #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>
```

(#840 #842 by @tizmagik)

## Bug fixes

* `components` option should accept arrays.
* Do not convert URLs in Markdown to auto links (#793).
* Improved accessibility (#893 by @gergely-nagy).

---

❤️ Huge thanks to @okonet to help with this release, [CI](#904) and [docs](#905) improvements.️ ❤️
@styleguidist-bot
Copy link
Collaborator

🎉 This PR is included in version 7.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants