From e97d2eab5a3bba57133ab61d0fce143ee6ef7ac6 Mon Sep 17 00:00:00 2001 From: Tom Brien Date: Tue, 16 Jun 2020 15:47:07 +0100 Subject: [PATCH] docs(v2): wrap all plugin imports in require.resolve() (#2941) * Wrap all plugin imports in require.resolve() As per breaking change in 2.0.0-alpha0.56 * Wrap plugins in next version * Revert "Wrap plugins in next version" This reverts commit 5afa06e2439c338804511827a59065eac278ea0f. --- .../version-2.0.0-alpha.56/using-plugins.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/website/versioned_docs/version-2.0.0-alpha.56/using-plugins.md b/website/versioned_docs/version-2.0.0-alpha.56/using-plugins.md index 6e079ee229..5eebb80b7c 100644 --- a/website/versioned_docs/version-2.0.0-alpha.56/using-plugins.md +++ b/website/versioned_docs/version-2.0.0-alpha.56/using-plugins.md @@ -18,7 +18,7 @@ Then you add it in your site's `docusaurus.config.js`'s `plugins` option: ```jsx {3} title="docusaurus.config.js" module.exports = { // ... - plugins: ['@docusaurus/plugin-content-pages'], + plugins: [require.resolve('@docusaurus/plugin-content-pages')], }; ``` @@ -44,7 +44,7 @@ module.exports = { // ... plugins: [ [ - '@docusaurus/plugin-xxx', + require.resolve('@docusaurus/plugin-xxx'), { /* options */ }, @@ -59,7 +59,7 @@ Example: module.exports = { plugins: [ // Basic usage. - '@docusaurus/plugin-google-analytics', + require.resolve('@docusaurus/plugin-google-analytics'), // With options object (babel style) [ @@ -142,7 +142,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it module.exports = { plugins: [ [ - '@docusaurus/plugin-content-blog', + require.resolve('@docusaurus/plugin-content-blog'), { /** * Path to data on filesystem relative to site dir. @@ -226,7 +226,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it module.exports = { plugins: [ [ - '@docusaurus/plugin-content-docs', + require.resolve('@docusaurus/plugin-content-docs'), { /** * Path to data on filesystem relative to site dir. @@ -301,7 +301,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it module.exports = { plugins: [ [ - '@docusaurus/plugin-content-pages', + require.resolve('@docusaurus/plugin-content-pages'), { /** * Path to data on filesystem @@ -341,7 +341,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it ```js title="docusaurus.config.js" module.exports = { - plugins: ['@docusaurus/plugin-google-analytics'], + plugins: [require.resolve('@docusaurus/plugin-google-analytics')], themeConfig: { googleAnalytics: { trackingID: 'UA-141789564-1', @@ -372,7 +372,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it ```js title="docusaurus.config.js" module.exports = { - plugins: ['@docusaurus/plugin-google-gtag'], + plugins: [require.resolve('@docusaurus/plugin-google-gtag')], themeConfig: { gtag: { trackingID: 'UA-141789564-1', @@ -403,7 +403,7 @@ If you have installed `@docusaurus/preset-classic`, you don't need to install it module.exports = { plugins: [ [ - '@docusaurus/plugin-sitemap', + require.resolve('@docusaurus/plugin-sitemap'), { cacheTime: 600 * 1000, // 600 sec - cache purge period changefreq: 'weekly', @@ -427,7 +427,7 @@ Modify your `docusaurus.config.js` ```diff module.exports = { ... -+ plugins: ['@docusaurus/plugin-ideal-image'], ++ plugins: [require.resolve('@docusaurus/plugin-ideal-image')], ... } ```