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

docs: remove Yarn instructions

Browse Source
This commit is contained in:
Hans Pagel
2021-11-09 11:56:27 +01:00
parent 345abcc00c
commit 7e476ec617
55 changed files with 33 additions and 271 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/overview/upgrade-guide.md
View File

@@ -23,11 +23,7 @@ The whole package structure has changed, we even moved to another npm namespace,
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
npm uninstall tiptap tiptap-commands tiptap-extensions tiptap-utils
```
## Install Tiptap v2
@@ -35,11 +31,7 @@ yarn remove Tiptap Tiptap-commands Tiptap-extensions Tiptap-utils
Once you have uninstalled the old version of Tiptap, install the new Vue 2 package and the starter kit:
```bash
# install with npm
npm install @tiptap/vue-2 @tiptap/starter-kit
# install with Yarn
yarn add @tiptap/vue-2 @tiptap/starter-kit
```
## Keep Tiptap v2 up to date
@@ -55,6 +47,13 @@ You can add the `--latest` flag, to show all possible upgrades – even if they
yarn upgrade-interactive --latest
```
Unfortunately, for npm there is no integrated tool, but you can use the `npm-check` package:
```bash
npm install -g npm-check
npm-check -u
```
## Explicitly register the Document, Text and Paragraph extensions
tiptap 1 tried to hide a few required extensions from you with the default setting `useBuiltInExtensions: true`. That setting has been removed and you’re required to import all extensions. Be sure to explicitly import at least the [`Document`](/api/nodes/document), [`Paragraph`](/api/nodes/paragraph) and [`Text`](/api/nodes/text) extensions.