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

Add install instructions

Browse Source 
This makes it easier than having to navigate over to the `installation` page.
This commit is contained in:
Max Reynolds
2021-04-22 06:06:45 +01:00
committed by Hans Pagel
parent 9110258a4c
commit 2f159f6671
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -27,6 +27,18 @@ npm uninstall tiptap tiptap-commands tiptap-extensions tiptap-utils
yarn remove tiptap tiptap-commands tiptap-extensions tiptap-utils yarn remove tiptap tiptap-commands tiptap-extensions tiptap-utils
``` ```
### Install tiptap 2.x
Once you have uninstalled the old version of tiptap, install the core repository and starter kit:
```
# install with npm
npm install @tiptap/core @tiptap/starter-kit
# install with Yarn
yarn add @tiptap/core @tiptap/starter-kit
```
### Explicitly register the Document, Text and Paragraph extensions ### 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. 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.