From 435e9a6049c1c2983680605ed8914d2a4ff57f4a Mon Sep 17 00:00:00 2001
From: Hans Pagel <hans.pagel@ueber.io>
Date: Fri, 29 Jan 2021 22:05:47 +0100
Subject: [PATCH] docs: update the integration guides

---
 .../guide/getting-started/alpinejs.md         |  3 ++
 .../guide/getting-started/intertiajs.md       |  5 ++++
 .../guide/getting-started/livewire.md         |  3 ++
 .../docPages/guide/getting-started/nextjs.md  |  3 ++
 .../docPages/guide/getting-started/nuxtjs.md  |  2 +-
 .../docPages/guide/getting-started/react.md   |  3 ++
 .../docPages/guide/getting-started/svelte.md  |  8 +++++-
 .../getting-started/{vue-cli.md => vuejs.md}  | 28 +++++--------------
 docs/src/links.yaml                           |  6 ++--
 9 files changed, 35 insertions(+), 26 deletions(-)
 rename docs/src/docPages/guide/getting-started/{vue-cli.md => vuejs.md} (79%)

diff --git a/docs/src/docPages/guide/getting-started/alpinejs.md b/docs/src/docPages/guide/getting-started/alpinejs.md
index 5a73adf27..74de0b442 100644
--- a/docs/src/docPages/guide/getting-started/alpinejs.md
+++ b/docs/src/docPages/guide/getting-started/alpinejs.md
@@ -2,6 +2,9 @@
 
 ## toc
 
+## Introduction
+The following guide describes how to integrate tiptap with your [Alpine.js](https://github.com/alpinejs/alpine) project.
+
 TODO
 
 https://codesandbox.io/s/alpine-tiptap-2ro5e?file=/index.html:0-1419
diff --git a/docs/src/docPages/guide/getting-started/intertiajs.md b/docs/src/docPages/guide/getting-started/intertiajs.md
index 1b1a7cd78..d4f05a506 100644
--- a/docs/src/docPages/guide/getting-started/intertiajs.md
+++ b/docs/src/docPages/guide/getting-started/intertiajs.md
@@ -2,6 +2,11 @@
 
 ## toc
 
+## Introduction
+The following guide describes how to integrate tiptap with your [Inertia.js](https://inertiajs.com/) project.
+
+## toc
+
 TODO
 
 ## Introduction
diff --git a/docs/src/docPages/guide/getting-started/livewire.md b/docs/src/docPages/guide/getting-started/livewire.md
index 4085a9a8d..bba3daef6 100644
--- a/docs/src/docPages/guide/getting-started/livewire.md
+++ b/docs/src/docPages/guide/getting-started/livewire.md
@@ -2,6 +2,9 @@
 
 ## toc
 
+## Introduction
+The following guide describes how to integrate tiptap with your [Livewire](https://laravel-livewire.com/) project.
+
 TODO
 
 editor.blade.php
diff --git a/docs/src/docPages/guide/getting-started/nextjs.md b/docs/src/docPages/guide/getting-started/nextjs.md
index db54da0df..10ad2d60a 100644
--- a/docs/src/docPages/guide/getting-started/nextjs.md
+++ b/docs/src/docPages/guide/getting-started/nextjs.md
@@ -2,6 +2,9 @@
 
 ## toc
 
+## Introduction
+The following guide describes how to integrate tiptap with your [Next.js](https://nextjs.org/) project.
+
 TODO
 
 <demo name="React" mode="react" />
diff --git a/docs/src/docPages/guide/getting-started/nuxtjs.md b/docs/src/docPages/guide/getting-started/nuxtjs.md
index 2d31d4885..6893d9221 100644
--- a/docs/src/docPages/guide/getting-started/nuxtjs.md
+++ b/docs/src/docPages/guide/getting-started/nuxtjs.md
@@ -3,7 +3,7 @@
 ## toc
 
 ## Introduction
-The following guide describes how to integrate tiptap with your Nuxt.js project.
+The following guide describes how to integrate tiptap with your [Nuxt.js](https://nuxtjs.org/) project.
 
 ## Requirements
 * [Node](https://nodejs.org/en/download/) installed on your machine
diff --git a/docs/src/docPages/guide/getting-started/react.md b/docs/src/docPages/guide/getting-started/react.md
index 263665650..b7d6acfc7 100644
--- a/docs/src/docPages/guide/getting-started/react.md
+++ b/docs/src/docPages/guide/getting-started/react.md
@@ -2,6 +2,9 @@
 
 ## toc
 
+## Introduction
+The following guide describes how to integrate tiptap with your [React](https://reactjs.org/) project.
+
 TODO
 
 <demo name="React" mode="react" />
diff --git a/docs/src/docPages/guide/getting-started/svelte.md b/docs/src/docPages/guide/getting-started/svelte.md
index 3e991fd75..d7dcafcc6 100644
--- a/docs/src/docPages/guide/getting-started/svelte.md
+++ b/docs/src/docPages/guide/getting-started/svelte.md
@@ -1,5 +1,10 @@
 # Svelte
 
+## toc
+
+## Introduction
+The following guide describes how to integrate tiptap with your Svelte project.
+
 TODO
 
 Svelte REPL: https://svelte.dev/repl/c839da77db2444e5b23a752266613639?version=3.31.2
@@ -15,7 +20,7 @@ App.svelte
 
 Editor.svelte
 ```html
-<script>
+<script type="module">
 	import { onMount } from 'svelte'
 	import { Editor } from '@tiptap/core'
   import { defaultExtensions } from '@tiptap/starter-kit'
@@ -44,3 +49,4 @@ Editor.svelte
 {/if}
 
 <div bind:this={element} />
+```
diff --git a/docs/src/docPages/guide/getting-started/vue-cli.md b/docs/src/docPages/guide/getting-started/vuejs.md
similarity index 79%
rename from docs/src/docPages/guide/getting-started/vue-cli.md
rename to docs/src/docPages/guide/getting-started/vuejs.md
index bc3b6af14..3dfda933a 100644
--- a/docs/src/docPages/guide/getting-started/vue-cli.md
+++ b/docs/src/docPages/guide/getting-started/vuejs.md
@@ -3,28 +3,14 @@
 ## toc
 
 ## Introduction
-The following guide describes how to integrate tiptap with your Vue CLI project. If you’ve got Vue CLI on your machine already, you can skip the first step.
+The following guide describes how to integrate tiptap with your [Vue](https://vuejs.org/) CLI project.
 
 ## Requirements
 * [Node](https://nodejs.org/en/download/) installed on your machine
+* [Vue CLI](https://cli.vuejs.org/) installed on your machine
 * Experience with [Vue](https://vuejs.org/v2/guide/#Getting-Started)
 
-## 1. Install Vue CLI (optional)
-Vue CLI aims to be the standard tooling baseline for the Vue ecosystem, and helps to create new projects quickly. If you’re working with Vue a lot, chances are you have this installed already. Just skip this step then.
-
-Here is how you could install (or update) it:
-
-```bash
-# with npm
-npm install -g @vue/cli
-
-# with Yarn
-yarn global add @vue/cli
-```
-
-From now on, the `vue` command is available globally. Test it with `vue --version`, this should output the current version.
-
-## 2. Create a project (optional)
+## 1. Create a project (optional)
 If you already have an existing Vue project, that’s fine too. Just skip this step and proceed with the next step.
 
 For the sake of this guide, let’s start with a fresh Vue project called `tiptap-example`. The Vue CLI sets up everything we need, just select the default Vue 2 template.
@@ -37,7 +23,7 @@ vue create tiptap-example
 cd tiptap-example
 ```
 
-## 3. Install the dependencies
+## 2. Install the dependencies
 Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need `@tiptap/core` (the actual editor) and the `@tiptap/vue-starter-kit` which has everything to get started quickly, for example a few default extensions and a basic Vue component.
 
 ```bash
@@ -50,7 +36,7 @@ yarn add @tiptap/core @tiptap/vue-starter-kit
 
 If you followed step 1 and 2, you can now start your project with `npm run dev` or `yarn dev`, and open [http://localhost:8080/](http://localhost:3000/) in your favorite browser. This might be different, if you’re working with an existing project.
 
-## 4. Create a new component
+## 3. Create a new component
 To actually start using tiptap, you’ll need to add a new component to your app. Let’s call it `Tiptap` and put the following example code in `components/Tiptap.vue`.
 
 This is the fastest way to get tiptap up and running with Vue. It will give you a very basic version of tiptap, without any buttons. No worries, you will be able to add more functionality soon.
@@ -88,7 +74,7 @@ export default {
 </script>
 ```
 
-## 5. Add it to your app
+## 4. Add it to your app
 Now, let’s replace the content of `src/App.vue` with the following example code to use our new `Tiptap` component in our app.
 
 ```html
@@ -112,7 +98,7 @@ export default {
 
 You should now see tiptap in your browser. You’ve successfully set up tiptap! Time to give yourself a pat on the back. Let’s start to configure your editor in the next step.
 
-## 6. Use v-model (optional)
+## 5. Use v-model (optional)
 You’re probably used to bind your data with `v-model` in forms, that’s also possible with tiptap. Here is a working example component, that you can integrate in your project:
 
 <demo name="Guide/GettingStarted/VModel" />
diff --git a/docs/src/links.yaml b/docs/src/links.yaml
index 0c547d711..8688b4acd 100644
--- a/docs/src/links.yaml
+++ b/docs/src/links.yaml
@@ -6,11 +6,11 @@
       link: /overview/installation
     - title: Upgrade Guide
       link: /overview/upgrade-guide
-    - title: Contributing
-      link: /overview/contributing
     - title: Become a sponsor
       link: /sponsor
       type: sponsor
+    - title: Contributing
+      link: /overview/contributing
 
 - title: Examples
   link: /examples
@@ -50,7 +50,7 @@
       link: /guide/getting-started
       items:
         - title: Vue.js 2
-          link: /guide/getting-started/vue-cli
+          link: /guide/getting-started/vuejs
           skip: true
         - title: Nuxt.js
           link: /guide/getting-started/nuxtjs