From 9c8cb574fb437cb047a993a5819a7648d9f6be37 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Tue, 27 Oct 2020 22:43:38 +0100 Subject: [PATCH 1/2] add new extension links to the overview --- docs/src/docPages/api/extensions.md | 2 ++ docs/src/docPages/api/extensions/text-align.md | 2 +- docs/src/links.yaml | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/src/docPages/api/extensions.md b/docs/src/docPages/api/extensions.md index c7dfc51ba..fb64e40f7 100644 --- a/docs/src/docPages/api/extensions.md +++ b/docs/src/docPages/api/extensions.md @@ -26,6 +26,7 @@ You don’t have to use it, but we prepared a `@tiptap/vue-starter-kit` which in | [Heading](/api/extensions/heading) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-heading/) | | [History](/api/extensions/history) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-history/) | | [HorizontalRule](/api/extensions/horizontal-rule) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-horizontal-rule/) | +| [Image](/api/extensions/image) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-image/) | | [Italic](/api/extensions/italic) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-italic/) | | [Link](/api/extensions/link) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-link/) | | [ListItem](/api/extensions/list-item) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-list-item/) | @@ -33,6 +34,7 @@ You don’t have to use it, but we prepared a `@tiptap/vue-starter-kit` which in | [Paragraph](/api/extensions/paragraph) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-paragraph/) | | [Strike](/api/extensions/strike) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-strike/) | | [Text](/api/extensions/text) | Yes | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text/) | +| [TextAlign](/api/extensions/text-align) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-text-align/) | | [Underline](/api/extensions/underline) | – | [GitHub](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-underline/) | diff --git a/docs/src/docPages/api/extensions/text-align.md b/docs/src/docPages/api/extensions/text-align.md index fdb3680af..4ebd9d234 100644 --- a/docs/src/docPages/api/extensions/text-align.md +++ b/docs/src/docPages/api/extensions/text-align.md @@ -1,4 +1,4 @@ -# Text Align +# TextAlign ## Installation ```bash diff --git a/docs/src/links.yaml b/docs/src/links.yaml index 1b6e7e8d2..7ca0c43c6 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -164,7 +164,7 @@ # draft: true - title: Text link: /api/extensions/text - - title: Text Align + - title: TextAlign link: /api/extensions/text-align draft: true # - title: TodoItem From af74a87820a7be8c9e1d2cd51aa1080677eeab37 Mon Sep 17 00:00:00 2001 From: Hans Pagel Date: Tue, 27 Oct 2020 23:04:18 +0100 Subject: [PATCH 2/2] add note regarding vue 3 to the upgrade guide --- docs/src/docPages/overview/upgrade-guide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/docPages/overview/upgrade-guide.md b/docs/src/docPages/overview/upgrade-guide.md index e996d06c9..b787f3001 100644 --- a/docs/src/docPages/overview/upgrade-guide.md +++ b/docs/src/docPages/overview/upgrade-guide.md @@ -14,6 +14,9 @@ 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: +### Upgrade to Vue.js 3 +… + ### 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/extensions/document), [Paragraph](/api/extensions/paragraph) and [Text](/api/extensions/text) extensions.