diff --git a/docs/src/docPages/installation.md b/docs/src/docPages/installation.md index 2cc48a22..5463f7b7 100644 --- a/docs/src/docPages/installation.md +++ b/docs/src/docPages/installation.md @@ -49,7 +49,7 @@ import { defaultExtensions } from '@tiptap/starter-kit' new Editor({ element: document.querySelector('.element'), extensions: defaultExtensions(), - content: '

Your content.

', + content: '

Hello World!

', }) ``` diff --git a/docs/src/docPages/installation/cdn.md b/docs/src/docPages/installation/cdn.md index 502ccdbd..1f234802 100644 --- a/docs/src/docPages/installation/cdn.md +++ b/docs/src/docPages/installation/cdn.md @@ -14,7 +14,7 @@ For testing purposes or demos, use our [Skypack](https://www.skypack.dev/) CDN b const editor = new Editor({ element: document.querySelector('.element'), extensions: defaultExtensions(), - content: '

Your content.

', + content: '

Hello World!

', }) diff --git a/docs/src/docPages/installation/svelte.md b/docs/src/docPages/installation/svelte.md index d1d9f8ed..78d41686 100644 --- a/docs/src/docPages/installation/svelte.md +++ b/docs/src/docPages/installation/svelte.md @@ -3,22 +3,46 @@ ## toc ## Introduction -The following guide describes how to integrate tiptap with your Svelte project. +The following guide describes how to integrate tiptap with your [SvelteKit](https://kit.svelte.dev/) project. -TODO +## Take a shortcut: Svelte REPL with tiptap +If you just want to jump into it right-away, here is a [Svelte REPL with tiptap](https://svelte.dev/repl/798f1b81b9184780aca18d9a005487d2?version=3.31.2) installed. -Svelte REPL: https://svelte.dev/repl/3651789dcfcb40de80b1ba36263d4bbd?version=3.31.2 +## Requirements +* [Node](https://nodejs.org/en/download/) installed on your machine +* Experience with [Svelte](https://vuejs.org/v2/guide/#Getting-Started) -App.svelte -```html - +## 1. Create a project (optional) +If you already have an existing SvelteKit 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 SvelteKit project called `tiptap-example`. The following commands set up everything we need. It asks a lot of questions, but just use what floats your boat or use the defaults. + +```bash +mkdir tiptap-example +cd tiptap-example +npm init svelte@next +npm install +npm run dev ``` -Editor.svelte +## 2. Install the dependencies +Okay, enough of the boring boilerplate work. Let’s finally install tiptap! For the following example you’ll need the `@tiptap/core` package, with a few components, and `@tiptap/starter-kit` which has the most common extensions to get started quickly. + +```bash +# install with npm +npm install @tiptap/core @tiptap/starter-kit + +# install with Yarn +yarn add @tiptap/core @tiptap/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:3000/](http://localhost:3000/) in your favorite browser. This might be different, if you’re working with an existing project. + +## 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 `src/lib/Tiptap.svelte`. + +This is the fastest way to get tiptap up and running with SvelteKit. It will give you a very basic version of tiptap, without any buttons. No worries, you will be able to add more functionality soon. + ```html {#if editor} - - - {/if} @@ -66,3 +98,18 @@ Editor.svelte } ``` + +## 4. Add it to your app +Now, let’s replace the content of `src/routes/index.svelte` with the following example code to use our new `Tiptap` component in our app. + +```html + + +
+ +
+``` + +You should now see tiptap in your browser. You’ve successfully set up tiptap! Time to give yourself a pat on the back. diff --git a/docs/src/docPages/installation/vue3.md b/docs/src/docPages/installation/vue3.md index 0818070b..d142d437 100644 --- a/docs/src/docPages/installation/vue3.md +++ b/docs/src/docPages/installation/vue3.md @@ -8,7 +8,7 @@ The following guide describes how to integrate tiptap with your [Vue](https://vu ## 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) +* Experience with [Vue](https://v3.vuejs.org/guide/introduction.html) ## 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. diff --git a/docs/src/links.yaml b/docs/src/links.yaml index bfe5a928..1993ebf7 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -8,7 +8,6 @@ skip: true - title: React link: /installation/react - type: new skip: true - title: Vue 3 link: /installation/vue3 @@ -21,8 +20,11 @@ skip: true - title: Svelte link: /installation/svelte - type: draft + type: new skip: true + # - title: CodeSandbox + # link: /installation/codesandbox + # skip: true - title: Alpine.js link: /installation/alpine type: draft @@ -31,9 +33,6 @@ link: /installation/livewire type: draft skip: true - - title: CodeSandbox - link: /installation/codesandbox - skip: true - title: Upgrade guide link: /overview/upgrade-guide - title: Become a sponsor