From cc4e0753437f19105dd601c1c575806c2caa0b28 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Tue, 15 Dec 2020 15:13:07 +0100 Subject: [PATCH] docs: addc ontent --- docs/src/docPages/overview/upgrade-guide.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/src/docPages/overview/upgrade-guide.md b/docs/src/docPages/overview/upgrade-guide.md index 20d78f66..8cd1a0e5 100644 --- a/docs/src/docPages/overview/upgrade-guide.md +++ b/docs/src/docPages/overview/upgrade-guide.md @@ -14,9 +14,22 @@ Yes, it’s tedious work to upgrade your favorite text editor to a new API, but ## Upgrading from 1.x to 2.x The new API will look pretty familiar too you, but there are a ton of changes though. To make the upgrade a little bit easier, here is everything you need to know: +### Uninstall tiptap 1.x +The whole package structure has changed, we even moved to another npm namespace, so you’ll need to remove the old version entirely before upgrading to tiptap 2. + +Otherwise you’ll run into an exception, for example “looks like multiple versions of prosemirror-model were loaded”. + +```bash +# with npm +npm uninstall tiptap tiptap-commands tiptap-extensions tiptap-utils + +# with Yarn +yarn remove tiptap tiptap-commands tiptap-extensions tiptap-utils +``` + ### Upgrade to Vue.js 3 :::warning Work in progress -We’re waiting for Gridsome to be compatible with Vue.js 3. +We’re [waiting for Gridsome](https://github.com/gridsome/gridsome/issues/1289) to be compatible with Vue.js 3. ::: ### Explicitly register the Document, Text and Paragraph extensions