docs: update content

This commit is contained in:
Hans Pagel
2021-04-03 17:30:56 +02:00
parent 3c963c302b
commit bdccc66d0f
5 changed files with 72 additions and 26 deletions

View File

@@ -49,7 +49,7 @@ import { defaultExtensions } from '@tiptap/starter-kit'
new Editor({ new Editor({
element: document.querySelector('.element'), element: document.querySelector('.element'),
extensions: defaultExtensions(), extensions: defaultExtensions(),
content: '<p>Your content.</p>', content: '<p>Hello World!</p>',
}) })
``` ```

View File

@@ -14,7 +14,7 @@ For testing purposes or demos, use our [Skypack](https://www.skypack.dev/) CDN b
const editor = new Editor({ const editor = new Editor({
element: document.querySelector('.element'), element: document.querySelector('.element'),
extensions: defaultExtensions(), extensions: defaultExtensions(),
content: '<p>Your content.</p>', content: '<p>Hello World!</p>',
}) })
</script> </script>
</body> </body>

View File

@@ -3,22 +3,46 @@
## toc ## toc
## Introduction ## 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 ## 1. Create a project (optional)
```html If you already have an existing SvelteKit project, thats fine too. Just skip this step and proceed with the next step.
<script>
import Editor from './Editor.svelte';
</script>
<Editor /> For the sake of this guide, lets 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. Lets finally install tiptap! For the following example youll 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 youre working with an existing project.
## 3. Create a new component
To actually start using tiptap, youll need to add a new component to your app. Lets 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 ```html
<script type="module"> <script type="module">
import { onMount, onDestroy } from 'svelte' import { onMount, onDestroy } from 'svelte'
@@ -32,7 +56,7 @@ Editor.svelte
editor = new Editor({ editor = new Editor({
element: element, element: element,
extensions: defaultExtensions(), extensions: defaultExtensions(),
content: '<p>Hello <strong>Svelte</strong>!<p>', content: '<p>Hello World! 🌍️ </p>',
onTransaction: () => { onTransaction: () => {
// force re-render so `editor.isActive` works as expected // force re-render so `editor.isActive` works as expected
editor = editor editor = editor
@@ -41,19 +65,27 @@ Editor.svelte
}) })
onDestroy(() => { onDestroy(() => {
editor.destroy() if (editor) {
editor.destroy()
}
}) })
</script> </script>
{#if editor} {#if editor}
<button on:click={() => editor.chain().focus().toggleBold().run()} class:active={editor.isActive('bold')}> <button
Bold on:click={() => editor.chain().focus().toggleHeading({ level: 1}).run()}
class:active={editor.isActive('heading', { level: 1 })}
>
H1
</button> </button>
<button on:click={() => editor.chain().focus().toggleItalic().run()} class:active={editor.isActive('italic')}> <button
Italic on:click={() => editor.chain().focus().toggleHeading({ level: 2 }).run()}
class:active={editor.isActive('heading', { level: 2 })}
>
H2
</button> </button>
<button on:click={() => editor.chain().focus().toggleStrike().run()} class:active={editor.isActive('strike')}> <button on:click={() => editor.chain().focus().setParagraph().run()} class:active={editor.isActive('paragraph')}>
Strike P
</button> </button>
{/if} {/if}
@@ -66,3 +98,18 @@ Editor.svelte
} }
</style> </style>
``` ```
## 4. Add it to your app
Now, lets replace the content of `src/routes/index.svelte` with the following example code to use our new `Tiptap` component in our app.
```html
<script>
import Tiptap from '$lib/Tiptap.svelte'
</script>
<main>
<Tiptap />
</main>
```
You should now see tiptap in your browser. Youve successfully set up tiptap! Time to give yourself a pat on the back.

View File

@@ -8,7 +8,7 @@ The following guide describes how to integrate tiptap with your [Vue](https://vu
## Requirements ## Requirements
* [Node](https://nodejs.org/en/download/) installed on your machine * [Node](https://nodejs.org/en/download/) installed on your machine
* [Vue CLI](https://cli.vuejs.org/) 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) ## 1. Create a project (optional)
If you already have an existing Vue project, thats fine too. Just skip this step and proceed with the next step. If you already have an existing Vue project, thats fine too. Just skip this step and proceed with the next step.

View File

@@ -8,7 +8,6 @@
skip: true skip: true
- title: React - title: React
link: /installation/react link: /installation/react
type: new
skip: true skip: true
- title: Vue 3 - title: Vue 3
link: /installation/vue3 link: /installation/vue3
@@ -21,8 +20,11 @@
skip: true skip: true
- title: Svelte - title: Svelte
link: /installation/svelte link: /installation/svelte
type: draft type: new
skip: true skip: true
# - title: CodeSandbox
# link: /installation/codesandbox
# skip: true
- title: Alpine.js - title: Alpine.js
link: /installation/alpine link: /installation/alpine
type: draft type: draft
@@ -31,9 +33,6 @@
link: /installation/livewire link: /installation/livewire
type: draft type: draft
skip: true skip: true
- title: CodeSandbox
link: /installation/codesandbox
skip: true
- title: Upgrade guide - title: Upgrade guide
link: /overview/upgrade-guide link: /overview/upgrade-guide
- title: Become a sponsor - title: Become a sponsor