From b6f4e838a88b206c8a4489d2bb35f313b148f897 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Greg=20Berg=C3=A9?= Date: Thu, 17 Jan 2019 10:16:27 +0100 Subject: [PATCH] docs: fix webpack api doc --- packages/webpack-plugin/README.md | 12 ++++++------ .../src/pages/docs/api-loadable-webpack-plugin.mdx | 10 ++++++---- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/packages/webpack-plugin/README.md b/packages/webpack-plugin/README.md index 5142573..b645f42 100644 --- a/packages/webpack-plugin/README.md +++ b/packages/webpack-plugin/README.md @@ -26,12 +26,12 @@ module.exports = { Create a webpack loadable plugin. -| Arguments | Description | -| --------------------- | ------------------------------------------------- | -| `options` | Optional options | -| `options.filename` | Stats filename (default to `loadable-stats.json`) | -| `options.path` | Stats file path (default to webpack config `output.path`) | -| `options.writeToDisk` | Always write assets to disk (default to `false`) | +| Arguments | Description | +| ------------------------------ | ----------------------------------------------------------------------------------- | +| `options` | Optional options | +| `options.filename` | Stats filename (default to `loadable-stats.json`) | +| `options.writeToDisk` | Accepts `boolean` or `object`. Always write stats file to disk. Default to `false`. | +| `options.writeToDisk.filename` | Write assets to disk at given `filename` location | ```js new LoadablePlugin({ filename: 'stats.json', writeToDisk: true }) diff --git a/website/src/pages/docs/api-loadable-webpack-plugin.mdx b/website/src/pages/docs/api-loadable-webpack-plugin.mdx index 993f8d1..c0a9409 100644 --- a/website/src/pages/docs/api-loadable-webpack-plugin.mdx +++ b/website/src/pages/docs/api-loadable-webpack-plugin.mdx @@ -10,10 +10,12 @@ order: 30 Create a webpack loadable plugin. -| Arguments | Description | -| ------------------------------ | ------------------------------------------------- | -| `options` | Optional options | -| `options.writeToDisk.filename` | Write assets to disk at given `filename` location | +| Arguments | Description | +| ------------------------------ | ----------------------------------------------------------------------------------- | +| `options` | Optional options | +| `options.filename` | Stats filename (default to `loadable-stats.json`) | +| `options.writeToDisk` | Accepts `boolean` or `object`. Always write stats file to disk. Default to `false`. | +| `options.writeToDisk.filename` | Write assets to disk at given `filename` location | ```js new LoadablePlugin({ filename: 'stats.json', writeToDisk: true })