ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: addc ontent

Browse Source
This commit is contained in:
Hans Pagel
2020-12-15 15:13:07 +01:00
parent bb3aa9ad89
commit cc4e075343
1 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/src/docPages/overview/upgrade-guide.md
View File

@@ -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 ## 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: 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 ### Upgrade to Vue.js 3
:::warning Work in progress :::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 ### Explicitly register the Document, Text and Paragraph extensions