From b77ae9124756766d13bd97ba1c94fc98ac0eb564 Mon Sep 17 00:00:00 2001 From: Tom Brien Date: Tue, 16 Jun 2020 10:15:41 +0100 Subject: [PATCH] docs(v2): fix changelog require.resolve mention * Update change log The 2.0.0-alpha56 Change log does not make mention to the breaking change with plugin imports. The [GitHub release](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-alpha.56) does. This has meant that dependabot has missed this change in it's pull requests (which seemed to use the changelog in some cases) * Fix typo Was in the source I copied from GH release --- CHANGELOG-2.x.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG-2.x.md b/CHANGELOG-2.x.md index 831aea8ce5..f4f7146783 100644 --- a/CHANGELOG-2.x.md +++ b/CHANGELOG-2.x.md @@ -4,6 +4,11 @@ #### :boom: Breaking Change +- If you refer to modules (plugins) in your config file in a string form, you will need to replace them with `require.resolve` calls, for example: +```diff +- plugins: ['@docusaurus/plugin-google-analytics'] ++ plugins: [require.resolve('@docusaurus/plugin-google-analytics')] +``` - `docusaurus-theme-classic` - [#2818](https://github.com/facebook/docusaurus/pull/2818) feat(v2): automatically add base url to logo link ([@lex111](https://github.com/lex111)) - `docusaurus-theme-classic`, `docusaurus-theme-search-algolia`