ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: update content

Browse Source
This commit is contained in:
Hans Pagel
2021-04-15 21:48:19 +02:00
parent 680ce9b7aa
commit accceccd09
77 changed files with 240 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/src/docPages/installation.md
View File

@@ -3,17 +3,17 @@
## toc
## Introduction
tiptap 2 is framework-agnostic and even works with plain JavaScript, if that’s your thing. We’re working on guides for all the different frameworks and workflows. The following steps should help you to integrate tiptap in your JavaScript project.
tiptap is framework-agnostic and even works with Vanilla JavaScript, if that’s your thing. The following integration guides should help you to integrate tiptap in your JavaScript project.
## Integration guides
* [CDN](/installation/cdn)
* [CodeSandbox](/installation/codesandbox)
* [Vue 2](/installation/vue2)
<!-- * [CodeSandbox](/installation/codesandbox) -->
* [React](/installation/react)
* [Vue 3](/installation/vue3)
* [Vue 2](/installation/vue2)
* [Nuxt.js](/installation/nuxt)
* [React](/installation/react) (Draft)
* [Svelte](/installation/svelte) (Draft)
* [Alpine.js](/installation/alpine) (Draft)
* [Svelte](/installation/svelte)
* [Alpine.js](/installation/alpine)
* [Livewire](/installation/livewire) (Draft)
## Vanilla JavaScript
@@ -22,7 +22,7 @@ tiptap 2 is framework-agnostic and even works with plain JavaScript, if that’s
* [Node](https://nodejs.org/en/download/) installed on your machine
### 1. Install the dependencies
For the following example you will need `@tiptap/core` (the actual editor) and `@tiptap/starter-kit` which has everything to get started quickly, for example the most common extensions.
For the following example you will need `@tiptap/core` (the actual editor) and `@tiptap/starter-kit` which has the most common extensions to get started quickly.
```bash
# install with npm
@@ -40,7 +40,7 @@ Add the following HTML where you want the editor to be mounted:
```
### 3. Initialize the editor
Now, let’s initialize the editor in JavaScript:
Let’s initialize the editor in JavaScript now:
```js
import { Editor } from '@tiptap/core'
@@ -53,4 +53,4 @@ new Editor({
})
```
Open your project in the browser and you should see tiptap. Good work! Time to give yourself a pat on the back.
Open your project in the browser to see tiptap in action. Good work! Time to give yourself a pat on the back.