From 2f159f66710ee525a58c8b8623f6ee668490f3c3 Mon Sep 17 00:00:00 2001 From: Max Reynolds Date: Thu, 22 Apr 2021 06:06:45 +0100 Subject: [PATCH] Add install instructions This makes it easier than having to navigate over to the `installation` page. --- docs/src/docPages/overview/upgrade-guide.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/src/docPages/overview/upgrade-guide.md b/docs/src/docPages/overview/upgrade-guide.md index 158b8c69..e09869e5 100644 --- a/docs/src/docPages/overview/upgrade-guide.md +++ b/docs/src/docPages/overview/upgrade-guide.md @@ -27,6 +27,18 @@ npm uninstall 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 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.